diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..18ba1b6951f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ + + +- [ ] Closes #xxxx +- [ ] This PR follows our [AI policy](https://github.com/RustPython/.github/blob/main/AI_POLICY.md) + +## Summary + + diff --git a/DEVELOPMENT.md b/CONTRIBUTING.md similarity index 88% rename from DEVELOPMENT.md rename to CONTRIBUTING.md index 7573f0f2640..58954486eaf 100644 --- a/DEVELOPMENT.md +++ b/CONTRIBUTING.md @@ -1,4 +1,28 @@ -# RustPython Development Guide and Tips +# Contributing to RustPython + +Contributions are more than welcome, and in many cases we are happy to guide +contributors through PRs or on [**Discord**](https://discord.gg/vru8NypEhv). + +## Finding ways to help + +We label issues that would be good for a first time contributor as [`good first issue`](https://github.com/RustPython/RustPython/issues?q=label%3A%22good+first+issue%22+is%3Aissue+is%3Aopen+). +Also checkout the [issue tracker](https://github.com/RustPython/RustPython/issues) for all open issues. + +You can enhance CPython compatibility by increasing our unittest coverage, you can see [This pinned issue](https://github.com/RustPython/RustPython/issues/6839) to see which libs and tests need be updated to our current supported python version. + +Another approach is to checkout the source code: builtin functions and object +methods are often the simplest and easiest way to contribute. + +You can also simply run `python -I scripts/whats_left.py` to assist in finding any unimplemented method. + +## Use of AI + +We **require all use of AI in contributions to follow our +[AI Policy](https://github.com/RustPython/.github/blob/main/AI_POLICY.md)**. + +If your contribution does not follow the policy, it will be closed. + +## RustPython Development Guide and Tips RustPython attracts developers with interest and experience in Rust, Python, or WebAssembly. Whether you are familiar with Rust, Python, or diff --git a/README.md b/README.md index 6949c6e66e2..860709c1acb 100644 --- a/README.md +++ b/README.md @@ -229,24 +229,10 @@ For a high level overview of the components, see the [architecture](architecture ## Contributing -Contributions are more than welcome, and in many cases we are happy to guide -contributors through PRs or on Discord. Please refer to the -[development guide](DEVELOPMENT.md) as well for tips on developments. +Contributions are welcome and highly appreciated. To get started, check out the +[**contributing guidelines**](CONTRIBUTING.md). -With that in mind, please note this project is maintained by volunteers, some of -the best ways to get started are below: - -Most tasks are listed in the -[issue tracker](https://github.com/RustPython/RustPython/issues). Check issues -labeled with [good first issue](https://github.com/RustPython/RustPython/issues?q=label%3A%22good+first+issue%22+is%3Aissue+is%3Aopen+) if you wish to start coding. - -To enhance CPython compatibility, try to increase unittest coverage by checking this article: [How to contribute to RustPython by CPython unittest](https://rustpython.github.io/guideline/2020/04/04/how-to-contribute-by-cpython-unittest.html) - -Another approach is to checkout the source code: builtin functions and object -methods are often the simplest and easiest way to contribute. - -You can also simply run `python -I scripts/whats_left.py` to assist in finding any unimplemented -method. +You can also join us on [**Discord**](https://discord.gg/vru8NypEhv). ## Compiling to WebAssembly