mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-23 09:18:29 +00:00
Update CONTRIBUTING.md
Summary: Closes https://github.com/Instagram/IGListKit/pull/367 Differential Revision: D4365950 Pulled By: jessesquires fbshipit-source-id: eb364ab216570ad485af804b88f5680811bbc19c
This commit is contained in:
parent
e9ad6b199e
commit
f896a8b187
1 changed files with 3 additions and 9 deletions
12
.github/CONTRIBUTING.md
vendored
12
.github/CONTRIBUTING.md
vendored
|
|
@ -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
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue