Iglistkit: Update CONTRIUBUTING.md

Created on 7 Feb 2017  路  6Comments  路  Source: Instagram/IGListKit

https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md

Let's add:

  • How we do major and minor releases:
  • A "launch checklist" template (e.g. #471)
  • Testing philosophy (total coverage)
  • Update coding style

    • Restrict subclassing (objc macro, final in examples)

    • ivars v props

    • local vars instead of self.prop over & over

Anything I'm missing?

enhancement starter-task

Most helpful comment

Good point I should have documented that:

Basically we want 99% test coverage at all times. So if you're adding new stuff, get it tested.

When fixing bugs, try your hardest to recreate the bug in a unit test, then fix the test. This sets us up to never regress that issue again.

All 6 comments

Gonna start with this one instead! Already updated the Coding Style with the 3 new bullets. What you exactly mean with the "Testing Philosophy" @rnystrom? so I can be on the same page with you.

Good point I should have documented that:

Basically we want 99% test coverage at all times. So if you're adding new stuff, get it tested.

When fixing bugs, try your hardest to recreate the bug in a unit test, then fix the test. This sets us up to never regress that issue again.

Update Contributing.md aka Task list:

  • [x] How we add major and minor releases #471 (comment)
  • [x] A "launch checklist" template (e.g. #471)
  • [x] Testing philosophy (total coverage)
  • [x] Update coding style
    - Restrict subclassing (objc macro, final in examples)
    - ivars v props
    - local vars instead of self.prop over & over

Ok, gonna add that with the Title: Testing philosophy and the points you mentioned :)

Ok here's the Pull request I just made: https://github.com/Instagram/IGListKit/pull/558

Was this page helpful?
0 / 5 - 0 ratings