Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (46 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

63 lines (46 loc) · 3 KB
Raw

Contributing

Thank you for your interest in contributing! We need volunteer contributors like you to help grow this project.

You can find us at https://trafficmonitor.zulipchat.com/ for discussions, questions, and immediate community-based assistance.

Important resources (many coming soon):

Testing

We have not implemented a testing framework. Help us by suggesting or creating one!

Submitting changes

Please send a GitHub Pull Request to this repo to the dev branch 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), or we will squash commits.

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."

Coding conventions

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)

Branching strategy / git workflow

Contributors submit PRs against dev.

When a user performs a git clone, it will pull down the main branch, which shall be tied to the latest stable release. We still recommend you use tagged releases for production deployments.

Git flow branching strategy diagram

Git naming convention / branch naming

Shall:

  • Include a short descriptive summary in imperative present tense
  • Use Hyphens for separating words

Should:

  • Include the work type:
    • feature for new functionality
    • refactor for update to existing functionality
    • bugfix for corrections to existing functionality
    • hotfix for critical fix to main
  • Include corresponding ticket/story id (e.g. from Jira, GitHub issue, etc.)

Suggested Format:
{work-type}/{short-summary}/{story-issue-ticket-id}

Example:

git checkout -b feature/oauth-migration/ATL-244

Thank you!

Thank you for your interest and contributions!