First off, thank you for considering contributing to Red Code Labs. It's people like you that make our open-source solutions so great! Please read the below guidelines if you want to contribute towards any of our projects.
Red Code Labs is an open source friendly organization, and we love to receive contributions from everyone. There are many ways which you can contribute, for example, but not limited to:
- bug reports
- feature requests
- writing docs
- general quality of code fixes and/or improvements
Please don't use any issue tracker for any form of support/'how to' questions. Feel free to ping our team on our Discord, so we can help you personally. If your issue is not strictly related to our tools, but rather the toolkits behind it (for example: Golang), Golang-related channels might be more active and more helpful. Keep in mind that we're also merely a bunch of humans, not masterminds who have sacred knowledge of every toolkit that we make use of.
Keep in mind that not all changes will be approved. We can also take a while before taking a look at your proposed changes/issues. Be welcome to everyone discussing your issue/pull request/whatever.
You're ready to make your first contribution. Feel free to ask for help; keep in mind that we still consider ourselves sort of beginners, so don't be too harsh on yourself either.
If you find a security vulnerability, do NOT open an issue, email us instead: [email protected]
There are not many projects in our org which might contain such vulnerabilities, however, one such example might be easyWSL, which was published to the MS Store. If you don't know if you're dealing with a security vulnerability, ask yourself: does this tool do something, that it's not meant to do, or in a way that enhances risk level for its user? If you're unsure - feel free to email us anyway.
You can use the bug reporting template via issue on any given repo. Please keep in mind to include as much detail as possible.
You can use the feature request/enhancement template via issue tracker. However, keep in mind that not all kinds of features will be implemented, but we will always take them into account and discuss them. Scoping the feature, thinking it through, explaining why it's needed, and especially providing info on how that might work is welcomed.
As mentioned previously, it can take some time on our end, however, we are aware of every opened issue/pull request, and discuss it internally, as well as with you, if that'd be required (not the case for very simple contributions, such as correcting spelling errors in the README of the project).
You can use our Discord server, feel free to ping us, but don't overuse that permission.
Generally speaking for the code - just follow language-specific code style. For commit messages - just a simple "fix something", "bump deps", or "update something" is more than good enough, we don't have any strict rules on that matter. For issues - we have templates to follow before submitting any (that is, either bug or feature request) kind of feature.