Skip to content

Commit

Permalink
Add docs for contributors. (ray-project#1191)
Browse files Browse the repository at this point in the history
* WIP: add docs for contributors.

* Remove changelog part.

* Simplify issue template.

* Simplify pull request template

* Simplify contributing doc.
  • Loading branch information
Christian Barra authored and pcmoritz committed Nov 10, 2017
1 parent 4f0da6f commit d36595c
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--
General questions should be asked on the mailing list [email protected].
Before submitting an issue, please fill out the following form.
-->

### System information
- **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**:
- **Ray installed from (source or binary)**:
- **Ray version**:
- **Python version**:
- **Exact command to reproduce**:

<!--
You can obtain the Ray version with
python -c "import ray; print(ray.__version__)"
-->

### Describe the problem
<!-- Describe the problem clearly here. -->

### Source code / logs
<!-- Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached. Try to provide a reproducible test case that is the bare minimum necessary to generate the problem. -->
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!--
Thank you for your contribution!
Please review https://github.com/ray-project/ray/blob/master/CONTRIBUTING.rst before opening a pull request.
-->

## What do these changes do?

<!-- Please give a short brief about these changes. -->

## Related issue number

<!-- Are there any issues opened that will be resolved by merging this change? -->
21 changes: 21 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Contributing to Ray
===================

Reporting bugs and asking questions
-----------------------------------

We use `GitHub issues`_ for bug reports and feature requests. For discussions
about development, questions about usage, or any general questions, we use our
mailing list `[email protected]`_.

To contribute a patch:
----------------------

1. Break your work into small, single-purpose patches if possible. It’s much
harder to merge in a large change with a lot of disjoint features.
2. Submit the patch as a GitHub pull request against the master branch.
3. Make sure that your code passes the unit tests.
4. Add new unit tests for your code.

.. _`GitHub issues`: https://github.com/ray-project/ray/issues
.. _`[email protected]`: https://groups.google.com/forum/#!forum/ray-dev

0 comments on commit d36595c

Please sign in to comment.