Skip to content

Commit

Permalink
Compliance bulk update. Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
renelehmann committed Oct 16, 2024
1 parent 6e64fe6 commit 7b8c092
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
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).

0 comments on commit 7b8c092

Please sign in to comment.