Skip to content

Commit f585abc

Browse files
committed
Compliance bulk update. Add CONTRIBUTING.md
1 parent 37fde06 commit f585abc

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CONTRIBUTING.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing
2+
3+
We welcome contributions and are really glad about your involvement in the project.
4+
5+
## Reporting Feedback
6+
7+
Use GitHub’s issues feature to report problems with and request enhancements to the functionality or documentation.
8+
9+
## Contributing Code
10+
11+
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.
12+
13+
### Commit Guidelines
14+
15+
All your commits must follow the [conventional commit message format](https://www.conventionalcommits.org/en/v1.0.0/#summary).
16+
17+
Valid scopes for this project are:
18+
19+
- `editor`: changes to the script editor GUI
20+
- `runner`: changes to the script execution logic
21+
- `meta`: changes to the build process, deployment, packaging or the project setup
22+
23+
Commits that fall into none of these scopes or change aspects in more than one of them should not specify a scope.
24+
25+
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.
26+
27+
### License
28+
29+
By contributing code or documentation, you agree to have your contribution licensed under [our license](/LICENSE).

0 commit comments

Comments
 (0)