forked from JamesClonk/backman
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Compliance bulk update. Add CONTRIBUTING.md
- Loading branch information
1 parent
6e64fe6
commit 7b8c092
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |