chore: Add CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,100 @@
+<!-- omit in toc -->
+# Contributing to Excalidraw Converter
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
+
+> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+> - Star the project
+> - Share it with anyone who might find it useful!
+
+<!-- omit in toc -->
+## Table of Contents
+
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+  - [Reporting Bugs](#reporting-bugs)
+  - [Suggesting Enhancements](#suggesting-enhancements)
+  - [Your First Code Contribution](#your-first-code-contribution)
+- [Styleguides](#styleguides)
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/sindrel/excalidraw-converter).
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/sindrel/excalidraw-converter/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an [Issue](https://github.com/sindrel/excalidraw-converter/issues/new).
+- Provide as much context as you can about what you're running into.
+
+## I Want To Contribute
+
+> ### Legal Notice <!-- omit in toc -->
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+### Reporting Bugs
+
+<!-- omit in toc -->
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/sindrel/excalidraw-converter). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/sindrel/excalidraw-converter/issues?q=label%3Abug+is:open).
+- Collect information about the bug:
+  - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+  - Possibly your input and the output
+  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+<!-- omit in toc -->
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. See the [security guidelines](SECURITY.md) for instructions.
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/sindrel/excalidraw-converter/issues/new).
+- Use the "Bug report" template and fill in all relevant sections.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+<!-- omit in toc -->
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://github.com/sindrel/excalidraw-converter) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/sindrel/excalidraw-converter/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+
+<!-- omit in toc -->
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/sindrel/excalidraw-converter/issues).
+
+- Open an [Issue](https://github.com/sindrel/excalidraw-converter/issues/new).
+- Use the "Feature request" template and fill in all relevant sections.
+
+### Your First Code Contribution
+
+- See the [Development instructions](README.md#development) for information on how to get started with development.
+- This project uses the [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow) workflow. To contribute, create a fork, then suggest your changes via a pull request.
+- Ensure that the pull request description describes your intentions, providing details such as "This adds support for x, addressing issue y", and offers an overview of the involved changes.
+- Make sure to add and/or update any tests and fixtures.
+
+Note that this project is maintained on a best-effort basis, and feedback times may vary.
+
+## Styleguides
+
+### Commit Messages and Pull Requests
+
+- Commits and pull requests titles should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) convention.
+- Write commit messages as if you were instructing the code base to act on them (using verbs). See examples of good commit messages [here](https://www.conventionalcommits.org/en/v1.0.0/#examples).
+
+<!-- omit in toc -->
+## Attribution
+This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

README.md

@@ -149,7 +149,7 @@ Converted Gliffy diagrams should also work in [draw.io](https://draw.io).
 In draw.io, you can import a diagram by simply opening the file from your device. If you're using draw.io for Confluence, you should be able use [the import dialog](https://drawio-app.com/blog/draw-io-for-confluence-now-with-gliffy-import/).
 
 ## Contributing
-See something you'd like to improve? Feel free to add a pull request. If it's a major change, it's probably best to describe it in an [issue](https://github.com/sindrel/excalidraw-converter/issues/new) first.
+See something you'd like to improve? Great! See the [contributing guidelines](CONTRIBUTING.md) for instructions.
 
 ## Attributions  
 * <a href="https://www.flaticon.com/free-icons/workflow" title="workflow icons">Workflow icons created by Freepik - Flaticon</a>
@@ -173,7 +173,7 @@ go test -v ./...
 
 ### Compile and run
 ```shell
-go run ./cmd/main.go <command> <input> <output>
+go run ./cmd/main.go <command> <arguments>
 ```
 
 </details>