Reorganize developer docs #1511

Closed
wants to merge 4 commits into
from

Projects

None yet

2 participants

@mdboom
Member
mdboom commented Nov 16, 2012

This is a reorganization of the developer docs. The main thrust here is to add a "pull request checklist" which is intended to be a concise and easy-to-follow checklist of things to ensure before a pull request is merged. Some larger sections of coding_guide.rst have been separated out into their own chapters.

There are a lot of instances where we (myself included) have said "oops -- forgot to document this feature committed a while back" or "forgot to add a CHANGELOG entry" etc. I thought that having a place to refer to every time would be helpful, and should also help new contributors understand what's expected, and take some burden off of the seasoned developers to say "please add tests, documentation, etc." in the pull request review -- we now have something we can just point to.

I don't necessarily want to get into an elaborate discussion about coding standards -- and I've tried to keep this simple so as to not seem overly rigid and daunting -- but if there's anything that should go on this list that isn't there already, please mention it here.

@mdboom
Member
mdboom commented Nov 16, 2012

Closing -- accidentally made this against master rather than 1.2.x.

@mdboom mdboom closed this Nov 16, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment