gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add Git details to CONTRIBUTING.md (#1663)

Browse Source
This commit is contained in:
Caleb 2018-08-27 14:04:11 -06:00 committed by Shawn Erquhart
parent e567d964a7
commit 99a699269b
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -120,15 +120,20 @@ yarn format
## Pull Requests ## Pull Requests
We actively welcome your pull requests. We actively welcome your pull requests!
1. Fork the repo and create your branch from `master`. If you need help with Git or our workflow, please ask on [Gitter.im](https://gitter.im/netlify/NetlifyCMS). We want your contributions even if you're just learning Git. Our maintainers are happy to help!
Netlify CMS uses the [Forking Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows#forking-workflow) + [Feature Branches](https://www.atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow). Additionally, PR's should be [rebased](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) on master when opened, and again before merging.
1. Fork the repo.
2. Create a branch from `master`. If you're addressing a specific issue, prefix your branch name with the issue number.
2. If you've added code that should be tested, add tests. 2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation. 3. If you've changed APIs, update the documentation.
4. Run `yarn test` and ensure the test suite passes. 4. Run `yarn test` and ensure the test suite passes.
5. Use `yarn format` to format and lint your code. 5. Use `yarn format` to format and lint your code.
6. PR's must be rebased before merge (feel free to ask for help) 6. PR's must be rebased before merge (feel free to ask for help).
7. PR should be reviewed by two maintainers (@erquhart, @Benaiah, @tech4him1) prior to merging. 7. PR should be reviewed by two maintainers prior to merging.
## Add yourself as a contributor ## Add yourself as a contributor