diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..f1e62a1f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,24 @@ + + +### 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**: + + + +### Describe the problem + + +### Source code / logs + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..3c435518a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ + + +## What do these changes do? + + + +## Related issue number + + diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 000000000..d3f2e6523 --- /dev/null +++ b/CONTRIBUTING.rst @@ -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 `ray-dev@googlegroups.com`_. + +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 +.. _`ray-dev@googlegroups.com`: https://groups.google.com/forum/#!forum/ray-dev