-
Notifications
You must be signed in to change notification settings - Fork 7.1k
Add docs for contributors. #1191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs for contributors. #1191
Conversation
|
Can one of the admins verify this patch? |
|
ok to test |
|
Merged build finished. Test FAILed. |
|
Test FAILed. |
|
Thanks for getting this started, this'll be really helpful! I haven't seen any other projects use a pull request template. Do you know of any? The CONTRIBUTING.rst file could be modeled after https://github.com/apache/arrow/blob/master/.github/CONTRIBUTING.md as well as https://github.com/tensorflow/tensorflow/blob/master/CONTRIBUTING.md. It may make sense to put instructions for getting set up for development somewhere else in the documentation. I don't feel strongly about this though. |
CONTRIBUTING.rst
Outdated
| Go to the link and make sure your doc changes looks good. | ||
|
|
||
|
|
||
| Changelog update |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section isn't relevant, is it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you send a PR about improving the docs I think it's a great idea to check the docs (so open the local link and...).
About Changelog, how do you collect the changes so far?
This is really useful if you want to collect info between releases and publish also the changelog, together with the new release.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We currently don't maintain a changelog. We could certainly add one, though we can always construct it after the fact just by looking through the commit history.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, so I will remove this changelog part.
|
About the pull request template just to cite a few: https://github.com/pandas-dev/pandas/blob/master/.github/PULL_REQUEST_TEMPLATE.md Also Keras has also something similar but inside the CONTRIBUTING.md I think it's nice to have because you can see what is needed directly inside the PR. |
|
Thanks for the links, those look reasonable. |
|
Merged build finished. Test FAILed. |
|
Test FAILed. |
|
@barrachri Mind if I take a pass over these docs (e.g., and push to your branch)? I'd prefer to start with more minimal versions of these files and then add to them as appropriate. |
|
@robertnishihara you are more than welcome in doing so. |
|
@barrachri I removed a lot of stuff, want to take a look? I'd suggest that we get this merged and then augment it as needed in follow up PRs. |
|
Merged build finished. Test FAILed. |
|
Test FAILed. |
|
I took some of the issue template from TensorFlow and the contributing doc from Arrow. |
|
Green light, I think you can merge! |
|
Thanks @barrachri! |
This PR try to address #1185.
Adding also github issue and PR templates.
It's WIP because I'd like to improve/clarify: