Add initial contributing guidelines

Now that develop is not the default, I’d like to clarify where PRs should go.
technology-ebay-de · Feb 16, 2017 · 0ecbb02 · 0ecbb02
1 parent 4b073c6
commit 0ecbb02
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,7 @@
+<!--
+Thanks for contributing!
+
+Please open pull requests against the `develop` branch, and add a relevant note to the `develop` section of the CHANGELOG [0] as part of your pull request.
+
+[0]: https://github.com/NYTimes/NYTPhotoViewer/blob/develop/CHANGELOG.md#develop
+-->
diff --git a/README.md b/README.md
@@ -53,6 +53,10 @@ This library requires a deployment target of iOS 8.0 or greater.
 
 See [`CHANGELOG.md`](https://github.com/NYTimes/NYTPhotoViewer/blob/develop/CHANGELOG.md).
 
+## Contributing
+
+Please **open pull requests against the `develop` branch**, and add a relevant note to the [`develop` section of the CHANGELOG](https://github.com/NYTimes/NYTPhotoViewer/blob/develop/CHANGELOG.md#develop) as part of your pull request.
+
 ## Swift
 
 NYTPhotoViewer is written in Objective-C but is fully interoperable with Swift. If you experience any interoperability difficulties, please open an issue or pull request and we will work to resolve it.