Skip to content

Conversation

@barrachri
Copy link
Contributor

@barrachri barrachri commented Nov 7, 2017

This PR try to address #1185.

Adding also github issue and PR templates.

It's WIP because I'd like to improve/clarify:

  • testing process
  • how to get a dev env ready
  • how to collect new contributors

@AmplabJenkins
Copy link

Can one of the admins verify this patch?

@robertnishihara
Copy link
Collaborator

ok to test

@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2288/
Test FAILed.

@robertnishihara
Copy link
Collaborator

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
Copy link
Collaborator

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?

Copy link
Contributor Author

@barrachri barrachri Nov 8, 2017

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.

Copy link
Collaborator

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.

Copy link
Contributor Author

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.

@barrachri
Copy link
Contributor Author

barrachri commented Nov 8, 2017

About the pull request template just to cite a few:

https://github.com/pandas-dev/pandas/blob/master/.github/PULL_REQUEST_TEMPLATE.md
https://github.com/dask/dask/blob/master/.github/PULL_REQUEST_TEMPLATE.md
https://github.com/apache/spark/blob/master/.github/PULL_REQUEST_TEMPLATE

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.
In this way as a admin you don't need to always remember that something is missing.

@robertnishihara
Copy link
Collaborator

Thanks for the links, those look reasonable.

@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2308/
Test FAILed.

@robertnishihara
Copy link
Collaborator

@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.

@barrachri
Copy link
Contributor Author

@robertnishihara you are more than welcome in doing so.

@robertnishihara
Copy link
Collaborator

@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.

@robertnishihara robertnishihara changed the title WIP: add docs for contributors. Add docs for contributors. Nov 10, 2017
@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2335/
Test FAILed.

@robertnishihara
Copy link
Collaborator

I took some of the issue template from TensorFlow and the contributing doc from Arrow.

@barrachri
Copy link
Contributor Author

Green light, I think you can merge!

@pcmoritz pcmoritz self-requested a review November 10, 2017 08:39
@pcmoritz pcmoritz merged commit d36595c into ray-project:master Nov 10, 2017
@barrachri barrachri deleted the add_docs_for_contributors branch November 10, 2017 09:20
@robertnishihara
Copy link
Collaborator

Thanks @barrachri!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants