Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
flacle authored Nov 11, 2021
1 parent 9af2a6e commit 9aaf9b2
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# True Git Code Churn Contribution Guide
We want to make contributing to this repo as easy and transparent as possible.

So here we go, short and sweet:

1. We welcome any type of contribution(s), but any contribution(s) you make will be under the MIT software license!

2. We use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow). If you are not familiar with this concept, then read it through before proceeding.

3. When submitting ideas (under issues) or code changes, please consider backwards compatibility as much as possible. For example, scope a new feature as an optional argument so it does not break existing workflows for end users post upgrade.

4. Try to only include a package only when you really feel that it is absolutely necessary. True Git Code Churn is and will always intend to be very lightweight.

5. Consider the Git version and Python version when testing, it must work with Python version 3.5.3 and Git version 2.20.1 onwards.

6. When submitting a bug, try to include (1) a quick summary and/or background, (2) steps to reproduce, (3) sample code if necessary, (4) expectation(s), (5) actual finding(s), and finally (6) additional notes.

0 comments on commit 9aaf9b2

Please sign in to comment.