From f896a8b187637a4cc4b815a6aa95f279bd47d3d8 Mon Sep 17 00:00:00 2001 From: Jesse Squires Date: Fri, 23 Dec 2016 13:37:29 -0800 Subject: [PATCH] Update CONTRIBUTING.md Summary: Closes https://github.com/Instagram/IGListKit/pull/367 Differential Revision: D4365950 Pulled By: jessesquires fbshipit-source-id: eb364ab216570ad485af804b88f5680811bbc19c --- .github/CONTRIBUTING.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 86a2737a..76b9c4c3 100755 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -12,6 +12,7 @@ please open an issue on GitHub. 4. Ensure the test suite passes. 5. Make sure your code lints. 6. If you haven't already, complete the Contributor License Agreement ("CLA"). +7. Add an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. ## Experimental changes @@ -47,8 +48,7 @@ outlined on that page and do not file a public issue. * 4 spaces for indentation rather than tabs * Public classes and methods must contain header documentation -* When changing header docs, make sure to run the [jazzy](https://github.com/realm/jazzy) doc script: `./build_docs.sh` -* Use C functions whenever possible +* Use plain C functions whenever possible (as opposed to class methods) ## Updating Testing Dependencies @@ -58,13 +58,7 @@ If you need a different version of one of the testing dependencies, you will nee $ [sudo] gem install cocoapods ``` -Then within the project directory, run: - -``` -$ pod install -``` - -to update the dependency to that version. +Then within the project directory, run `pod install` to update the dependency to that version. ## License