Start combining various development documentation into one place. #9754
Conversation
|
|
||
| Now that the bug is fixed or the enhancement is in place, you need to write tests. | ||
| Any code you contribute must have adequate test coverage to be considered. Adding tests | ||
| is one of the most comment requests after code is pushed to *pandas*. Most often these |
|
@rockg this is pretty awesome! I would like to emphasize test driven development (TDD) |
|
I tried to keep things in order of how they are done. I think it makes sense where it is in the document--after building the code and before committing. I can put some mention of it at the top in the "working with code" section and make it more explicit in the testing section. Would that work? |
|
lgtm. @jorisvandenbossche @shoyer |
|
Indeed, thanks @rockg ! |
|
With this I would like to redirect http://pandas.pydata.org/developers.html and https://github.com/pydata/pandas/blob/master/CONTRIBUTING.md to this page. Does that sound good? I think CONTRIBUTING.md is what is linked when making a new pull request (something like "Please read the following guidelines..."). Is it possible to have something else show up in that message, e.g., a list of things, or can it only point to this file? |
|
I'm pretty sure the GitHub link can only point to the file with that name. On Thu, Apr 2, 2015 at 4:40 PM, rockg [email protected] wrote:
|
|
I can change the developers links to just about anything ok let's merge and I'll fix the link tonight then we can review everything and fix if needed |
Start combining various development documentation into one place.
|
I think we might need to link CONTRIBUTING.md to the dev page for this to work |
|
"dev page" is the page added for this PR, right? If so, yes, I think this is what we want. And then we llink the developers from pydata to the docs page as well. |
|
yep |
|
Better yet, probably link to "Contributing to the code base" |
|
@rockg Wow, this is great! |
|
http://pandas.pydata.org/index.html is updated (the About Pandas / Contributing Guidelines link), currently goes to the dev docs. |
| ------------------------------------ | ||
|
|
||
| Once your feature branch is accepted into upstream, you'll probably want to get rid of | ||
| the branch. First, merge upstream master into your branch so git knows it is safe to delete your branch :: |
There was a problem hiding this comment.
I believe merging is an unnecessary step. use '-D'.
| use cases and writing corresponding tests. | ||
|
|
||
| Adding tests is one of the most common requests after code is pushed to *pandas*. It is worth getting | ||
| in the habit of writing tests ahead of time so this is never an issue. |
There was a problem hiding this comment.
It is worth getting in the habit of writing tests ahead of time so this is never an issue.
... but that's good advice.
Closes #6232
In working with the various "Contributing" documents recently it was clear that we needed to combine them. This is a stab at doing so. I took the various components from pydata.org, CONTRIBUTING.md, various wiki pages, and the already included Documentation documents and created this file. I think it's a good start.