Skip to content

Latest commit

 

History

History
9 lines (5 loc) · 1.4 KB

File metadata and controls

9 lines (5 loc) · 1.4 KB

Contributing

If you are looking to contribute to the project, you are strongly encouraged to open a GitHub issue describing what you intend to do (e.g. fix a bug). The exception to this is if you're only making very minor changes such as typos. If in doubt, it doesn't hurt to just create an issue.

Depending on the scale of your intended changes (e.g. add new feature), you may find the Developer Guide useful for understanding the structure and design considerations for the project. You may also reach out on discord for clarifications. As a general rule of thumb, if you are touching the codebase directly, do give the developer guide a read.

For this project, the forking workflow is encouraged and you may open a pull request with clear descriptions on the changes and what they are intended to do (enhancement, bug fixes etc). Alternatively, you may simply report bugs or raise suggestions by opening an issue or submitting it on discord.

Note: Templates have been created for pull requests and issues to guide you in the process.