From 0ecbb02fcd84911fe6f898267df42188ac96d068 Mon Sep 17 00:00:00 2001 From: Chris Dzombak Date: Thu, 16 Feb 2017 11:34:52 -0500 Subject: [PATCH] Add initial contributing guidelines MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Now that develop is not the default, I’d like to clarify where PRs should go. --- .github/PULL_REQUEST_TEMPLATE.md | 7 +++++++ README.md | 4 ++++ 2 files changed, 11 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..0839124e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ + diff --git a/README.md b/README.md index 22ac0114..3e8a4116 100644 --- 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.