From 99a699269bb6c85b7504f3e2f49823c1abbcddf8 Mon Sep 17 00:00:00 2001 From: Caleb Date: Mon, 27 Aug 2018 14:04:11 -0600 Subject: [PATCH] docs: add Git details to CONTRIBUTING.md (#1663) --- CONTRIBUTING.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8fb7e4c8..c2c65f07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -120,15 +120,20 @@ yarn format ## 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. 3. If you've changed APIs, update the documentation. 4. Run `yarn test` and ensure the test suite passes. 5. Use `yarn format` to format and lint your code. -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. +6. PR's must be rebased before merge (feel free to ask for help). +7. PR should be reviewed by two maintainers prior to merging. ## Add yourself as a contributor