I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.
Here are some important resources:
Please write tests for new code you create.
Please open a Pull Request with a clear list of what you've done. We have a Pull Request template you can use to document your changes. When you send a pull request, we will love you forever if you include tests. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
Always write a clear log message for your commits. We prefer semantic commits using https://commitizen.github.io/cz-cli/
$ git commit -m "feat(README): A brief summary of the commit"
>
> A paragraph describing what changed and its if the message alone is not enough."
Start reading our code and you'll get the hang of it. We optimize for readability:
- We use Prettier and Standard JS for linting. All of our projects will have this installed, so make sure you have this configured in your IDE.