Skip to content

Commit 6707a17

Browse files
authored
Merge pull request #1762 from cortexproject/contrib-instructions
Add some words about what makes a good PR
2 parents 687841b + 82b3d4e commit 6707a17

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ Welcome! We're excited that you're interested in contributing. Below are some ba
66

77
Cortex follows a standard GitHub pull request workflow. If you're unfamiliar with this workflow, read the very helpful [Understanding the GitHub flow](https://guides.github.com/introduction/flow/) guide from GitHub.
88

9+
You are welcome to create draft PRs at any stage of readiness - this
10+
can be helpful to ask for assistance or to develop an idea. But before
11+
a piece of work is finished it should:
12+
13+
* Be organised into one or more commits, each of which has a commit message that describes all changes made in that commit ('why' more than 'what' - we can read the diffs to see the code that changed).
14+
* Each commit should build towards the whole - don't leave in back-tracks and mistakes that you later corrected.
15+
* Have tests for new functionality or tests that would have caught the bug being fixed.
16+
* Include a CHANGELOG message if users of Cortex need to hear about what you did.
17+
918
## Developer Certificates of Origin (DCOs)
1019

1120
Before submitting your work in a pull request, make sure that *all* commits are signed off with a **Developer Certificate of Origin** (DCO). Here's an example:

0 commit comments

Comments
 (0)