From 7b8c092bd106be9ebf5eea3a5f913821e77c25b5 Mon Sep 17 00:00:00 2001 From: Rene Lehmann Date: Wed, 16 Oct 2024 17:12:16 +0200 Subject: [PATCH] Compliance bulk update. Add CONTRIBUTING.md --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5e6d35d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing + +We welcome contributions and are really glad about your involvement in the project. + +## Reporting Feedback + +Use GitHub’s issues feature to report problems with and request enhancements to the functionality or documentation. + +## Contributing Code + +Code contributions are highly appreciated. Bug fixes and small enhancements can be handed in as pull-requests. For larger changes and features, please open a GitHub issue with your proposal first so the solution can be discussed. + +### Commit Guidelines + +All your commits must follow the [conventional commit message format](https://www.conventionalcommits.org/en/v1.0.0/#summary). + +Valid scopes for this project are: + +- `editor`: changes to the script editor GUI +- `runner`: changes to the script execution logic +- `meta`: changes to the build process, deployment, packaging or the project setup + +Commits that fall into none of these scopes or change aspects in more than one of them should not specify a scope. + +Ideally, each commit should should represent a working and buildable state but still only contain an atomic change compared to its parent. Please rewrite history accordingly before opening a PR. + +### License + +By contributing code or documentation, you agree to have your contribution licensed under [our license](/LICENSE).