Contribution Instructions

Note: This is a working document. When we have settled on a reasonable structure to our Contributing Guidelines, the contents of this document should be moved to CONTRIBUTING.md in line with GitHub guidance.

---

Table of Contents

1. Code of Conduct
2. I have a Question
3. Who can Contribute?
4. How do I Contribute?
   1. Reporting Bugs
   2. Suggesting Enhancements
   3. Your first Code Contribution
   4. Your first Documentation Contribution
   5. Your first Community Contribution
5. Style Guides
   1. All things Git
   2. Documentation
   3. Python

Code of Conduct

I have a Question

Who can Contribute?

How do I Contribute?

Reporting Bugs

Suggesting Enhancements

We welcome enhancement requests, no matter how simple or complex they may be. Before requesting an enhancement we do ask that you have a look through issues tagged enhancement to see if your request has been raised already. Please also take a look at this crowdsourced summary of problems we want to solve.

Remember, not all features will be implemented. If we've decided not to proceed with an enhancement, we do aim to provide a clear articulation of why the decision was made.

Your first Contribution to Code

Your first Contribution to Documentation

Your first Contribution to Maintenance

Style Guides

All things Git

Branching

Create a branch before working on an issue. Please follow our branch naming convention: issue-123-decsription.

• issue - the word 'issue' without quotes
• 123 - the issue number you will be working on
• description - a brief (2-3 word) hyphen separated description of what you will do

Example: issue-44-docker-environment

Creating a PR

Reviewing PRs

Documentation

Python

Migrations