Welcome! Community contributions are essential for keeping CarpoolVote running. We want to keep it as easy as possible to contribute changes. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
Different areas of this repo use different technologies. See the README.md for information about the area of your contributon.
- Join our Slack team. It's the best way to keep up to date with the project. Please email us if you would like to join.
- If you're new to GitHub and open-source, please familiarise yourself with the official guidelines.
- Check our GitHub issues to see what needs doing.
- Read the full issue description and any discussion before beginning your work.
- If the issue is unassigned, let us know if you want to take it, and we'll assign it you you.
- If it is already assigned, then find a different issue.
- Fork the repository on GitHub
- Create a feature branch for your work
- Create commits that have a clearly defined purpose
- Write commit messages that describe your change
- Submit a pull request to this repository
- New PRs will are reviewed and tested before a merge into master.
- Indicate in your PR description whether your PR is ready to merge, or whether you're still working on it.
- Please avoid merging your own PRs, especially for large features
- Ideally, every PR should have a senior project member sign off on it before being merged.
- If your PR is urgent, please announce it in the #backend Slack channel and one of us will try to prioritise reviewing and deploying it