Ecce pull request! Undocumented features Still shivering —-after Akutagawa Ryunosuke (1892-1927)
7.5.1. Reviewing principles¶
- Every PR should preserve or increase code coverage. If it ain’t green, it ain’t finished.
- Check it as a black box. Check the overall picture of input, “something happens”, output chain. If it ain’t documented, it ain’t finished.
- Check it as a white box. Check implementation details of “something-happens”. If it ain’t styled, it ain’t finished.
- Check it as a release news. Check commit messages. Are they understandable? Do they use FIX or BETTER labels? If a commit does not announce anything, it may not be finished. See Structured release notes.