Reorganize developer docs #1511
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Thanks to Mike Kaufman for reporting it to mpl-devel list
DOC: 'inout' option for tick_params direction
|
Closing -- accidentally made this against master rather than |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.rsthave 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.