diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..dd3ac1476e --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing to Lean + +Thank you for choosing to contribute to Lean, this document is a intended as a brief guide +for new contributors to help streamline the process and make it as easy as possible +for you (the contributors) and us (the mainatiners). + +### Writing Code + +- [Coding Style](doc/coding_style.md) +- [Library Style Conventions](doc/lean/library_style.org) +- [Git Commit Conventions](doc/commit_convention.md) +- [Automatic Builds](doc/make/travis.md) + +# Opening Issues + +- Checked that your issue isn't [already filed](https://github.com/leanprover/lean/issues). +- Specifically look over: + * the [wishlist](https://github.com/leanprover/lean/issues?q=is%3Aissue+is%3Aopen+label%3AI-wishlist), + * open [RFCs](https://github.com/leanprover/lean/issues?q=is%3Aissue+is%3Aopen+label%3ARFC), + * open [feature requests](https://github.com/leanprover/lean/issues?q=is%3Aissue+is%3Aopen+label%3AFeature). +- Reduce the issue to a self-contained, reproducible test case. + +# Opening Pull Requests + +- Ensure your Pull Request meets the coding and commit conventions documented above. +- Ensure your Pull Request contains tests for the behavior, for both features or + bug fixes. + + diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md similarity index 100% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE.md diff --git a/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from PULL_REQUEST_TEMPLATE.md rename to .github/PULL_REQUEST_TEMPLATE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index c2a5a8728a..0000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,24 +0,0 @@ -# Contributing to Lean - -### Writing Code - -- [Coding Style](doc/coding_style.md) -- [Library Style Conventions](doc/lean/library_style.org) -- [Git Commit Conventions](doc/commit_convention.md) -- [Automatic Builds](doc/make/travis.md) - -# Opening Issues - -- Checked that your issue isn't [already filed](https://github.com/leanprover/lean/issues). - * Look over the wishlist the [wishlist](https://github.com/leanprover/lean/issues?q=is%3Aissue+is%3Aopen+label%3AI-wishlist), open [RFCs](https://github.com/leanprover/lean/issues?q=is%3Aissue+is%3Aopen+label%3ARFC), - or [feature requests](https://github.com/leanprover/lean/issues?q=is%3Aissue+is%3Aopen+label%3AFeature). - * Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages - * Reduced the issue to a self-contained, reproducible test case. - -# Opening Pull Requests - -- Ensure your Pull Request meets the coding and commit conventions listed above. -- Ensure your Pull Request contains tests for the behavior whether a feature or - bug fix. - -