Thank you for your interest in contributing! We need volunteer developers like you to help grow this project.
You can find us at https://trafficmonitor.zulipchat.com/, Zulip acts as our organized team chat app. We want you working on things you are excited about.
Important resources (many coming soon):
- About us
- Roadmap
- Project management (Taiga)
- Use GitHub Issues to report bugs and make feature requests
- Traffic Monitor Zulic Chat to connect
We have not implemented a testing framework. Help us by suggesting or creating one!
Please send a GitHub Pull Request to this repo with a clear list of what you have done (read more about pull requests). 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. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
See our current code to help you get the hang of it:
- Indent with 4 spaces
- This is open source software. Consider the people who will read your code, and make it look nice for them.
- We use Linux line endings (see GitHub Docs - About line endings)
Must:
- Include a short descriptive summary in imperative present tense
- Use Hyphens for separating words
May:
- Include the work type: feature, refactor, bugfix, hotfix, etc.
- Include corresponding ticket/story id (e.g. from Jira, GitHub issue, etc.)
Suggested Format:
{work type e.g.}/{2-3 word summary}/{story or ticket id}_
Example:
git checkout -b feature/oauth-migration/ATL-244