Thank you for your interest in contributing! See the sections below for some relevant information about the different ways that you may contribute.
- Use the templates provided when filing a new issue.
- When contributing to existing issues, keep the conversation on-topic.
- Comments such as "Me too." or "+1" are not helpful and detract from the conversation. If you are experiencing an issue which is already open, a ":+1:" reaction is the best way to express that.
- If you have additional information that you think could be helpful in solving an issue, are aware of a workaround, or have some other information to contribute, definitely share.
- Do not comment on a closed issue if you are experiencing the same problem. Open a new issue, but feel free to reference the old one in your description.
- Before spending the time to implement a feature, please consult with me in my support channel in the Red Cog Support server.
- When submitting a fix for a reported issue, be sure to mention "fixes #<issue number>" somewhere in your pull request and/or in a commit message. This ensures that issues and the commits/pull requests which fix them are linked together.
- All code is linted using Black. The automated builds will ensure that your code is passing, but you can save some time by checking it yourself. A Makefile, as well as batch, PowerShell, and Bash scripts, are provided for convenience. The flags set in those scripts are the same as the ones used by the automated builds.
- I reserve the right to request any and all changes which I see fit on your pull request. That being said, I will always do my best to be fair and reasonable.
- If your pull request is for i18n support/translations, please read more here.