Skip to content

Commit f6bbc61

Browse files
authored
Merge pull request #3 from ckoven/rgknox-new-PR-template
added link to developer repo policy and fixed a couple typos
2 parents 7608e87 + 3d79084 commit f6bbc61

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@ Thank you for considering contributing to the development of FATES. There are a
66

77
https://github.com/NGEET/fates/blob/master/LICENSE.txt
88

9+
## If working with unreleased code, please read the use policy that governs the developer repository:
10+
11+
https://github.com/NGEET/fates/wiki/Use-and-distribution-policy-for-fates-developer-repository
912

1013
## Getting Started
1114

1215
Those who wish to contribute code to FATES must have those changes integrated through the developer repository NGEET/fates. Changes that make it to public releases must go through this repository first, as well. Here are some basic first steps.
1316

1417
* All developers should create a fork of the NGEET/fates repository into their personal space on github
1518
* Follow the developer work-flow described here: https://github.com/NGEET/fates/wiki/FATES-Development-Workflow
16-
17-
* Each set of changes should have it's own feature branch that encapsulates your desired changes, following the conventions outlined here: https://github.com/NGEET/fates/wiki/Feature-Branch-Naming-Convention
19+
* Each set of changes should have its own feature branch that encapsulates your desired changes, following the conventions outlined here: https://github.com/NGEET/fates/wiki/Feature-Branch-Naming-Convention
1820
* The work-flow will lead you eventually to submit a Pull-Request to NGEET/fates:master, please follow the template in the Pull Request and communicate as best you can if you are unsure how to fill out the text
19-
* It is best to create an issue to describe the work your are undertaking prior to starting. This helps the community sync with your efforts, prevents duplication of efforts, and science is not done in a vaccuum!
21+
* It is best to create an issue to describe the work you are undertaking prior to starting. This helps the community sync with your efforts, prevents duplication of efforts, and science is not done in a vaccuum!
2022
* Expect peers to interact, help, discuss and eventually approve your submission (pull-request)
2123

2224

@@ -36,7 +38,7 @@ Please refer to the FATES style guide: https://github.com/NGEET/fates/wiki/Codin
3638

3739
## Trivial Changes
3840

39-
If changes are trivial, its possible testing will not be required, conversations via the Pull Request will address if tests are not needed
41+
If changes are trivial, it's possible testing will not be required. Conversations via the Pull Request will address if tests are not needed
4042

4143
## Documentation
4244

0 commit comments

Comments
 (0)