Contributing¶

We are always looking for contributors. If you would like to contribute, this page should answer most of your questions. Join our Discord Server to ask questions and get help. :D

Where We Need Help¶

If you are looking to contribute, you can find needed contributions by checking

Code of Conduct¶

Please follow our Code of Conduct to keep our community approachable and respectable.

Commit Messages¶

Please use the following format for your commit messages:

{[<scope>]} <type>: <subject>

{details}

Fields with {} are optional.

Also ensure that all lines are no longer than 72 characters. Please wrap body lines at 72 characters.

Example¶

[core] feat: rick roll easter egg

This commit adds an easter egg which will never give you up or
let you down

Scopes¶

[core]: Core functionality (Optional to state)
[plugins]: Modifications to included plugins
[docs]: Documentation changes
[ci]: Changes to CI configuration

Types¶

(Not applicable for docs)

feat: A new feature
fix: A bug fix
refactor/ref: A code change that neither fixes a bug nor adds a feature and instead improves existing functionality (e.g. making code more clean, speeding up code, etc.)
chore: Other changes that don't modify the code (e.g. updating dependencies, formatting, etc.)
tests: Adding missing tests or correcting existing tests

Subject¶

The subject of a commit should answer this sentence:

If applied, this commit will ...

Pull Requests¶

Please create/send pull requests to the main repository