How Can I Help Contribute Code?
Last updated: January 14th, 2021
If you're a developer looking to pitch in, you're more than welcome to help out. Here are some suggestions for diving in:
Read the Documentation
Make sure you read the entire Readme to understand some basics about the project and how to run it. You can also check out our style guide for how to write code that matches the way we write things.
Make an Issue First
Before you dive into coding your change, it's often a good idea to first make an issue or work on an existing issue before you start. This will allow anyone to provide feedback about what you're going to work on before you spend time on something that may change. Likewise, it will prevent someone else from working on the same issue as you. Pull requests against an existing issue have a much higher chance of getting merged.
Write Unit Tests
If your changes touch the more structural parts of the codebase, you'll be asked to write tests for them, and make sure the existing tests pass. Detailed documentation of writing and running tests is forthcoming, but for now, just try to follow the example of existing tests.
Make a Detailed Pull Request
Make sure you follow the format of a new pull request where applicable.
You'll want to:
- Provide a detailed explanation for what your code does.
- List all of the high-level technical changes you've made.
- Provide a list of steps for testing your change (if applicable).
- Provide screenshots / gifs of the visual changes (if applicable).
- Pull requests that have the above information are much more likely to be accepted.