Create a fork of the project
Make your changes
Create a pull request
when creating a pull request, please make sure that
- You follow this projects naming conventions
- You follow this projects structure
- You remove all debugging helpers(byebug, puts, etc)
- You comment your code to explain how it works
- You add to the documentation if needed
- Your code works
- You make your code easily readable and modifiable
We want to foster an open and welcoming environment. We will answer any questions and issues. As this is a harassment-free environment, not being open to people of any kind will result in a ban.
Need help or want to bring something to our attention? Create an issue. There are multiple kinds but the 3 kinds that we support are bug report, code maintenance, and feature request.
We use labels to denote what is going on an issue. You can search by issues or use them as a quick guide to an issue.
some important labels are
bugwhen something isn't workingdependenciesto update the dependenciesenhancementfor adding a new feature or functionalityhelp wantedfor asking for helpquestionfor asking a questionsecurityfor an issue with security