Skip to content

Commit fc637a1

Browse files
authored
[META] AI policy (#7914)
* Add `CONTRIBUTING.md` and link it in the readme * Add TBD PR template * Merge `DEVELOPMENT.md` -> `CONTRIBUTING.md` * Revise `PULL_REQUEST_TEMPLATE.md` * Have checkboxes
1 parent 7d54ba5 commit fc637a1

3 files changed

Lines changed: 38 additions & 18 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!--
2+
Thanks for your contribution!
3+
-->
4+
5+
- [ ] Closes #xxxx <!-- Replace xxxx with the GitHub issue number -->
6+
- [ ] This PR follows our [AI policy](https://github.com/RustPython/.github/blob/main/AI_POLICY.md)
7+
8+
## Summary
9+
<!-- What's the purpose of the change? What does it do, and why? -->
10+

DEVELOPMENT.md renamed to CONTRIBUTING.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
1-
# RustPython Development Guide and Tips
1+
# Contributing to RustPython
2+
3+
Contributions are more than welcome, and in many cases we are happy to guide
4+
contributors through PRs or on [**Discord**](https://discord.gg/vru8NypEhv).
5+
6+
## Finding ways to help
7+
8+
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+).
9+
Also checkout the [issue tracker](https://github.com/RustPython/RustPython/issues) for all open issues.
10+
11+
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.
12+
13+
Another approach is to checkout the source code: builtin functions and object
14+
methods are often the simplest and easiest way to contribute.
15+
16+
You can also simply run `python -I scripts/whats_left.py` to assist in finding any unimplemented method.
17+
18+
## Use of AI
19+
20+
We **require all use of AI in contributions to follow our
21+
[AI Policy](https://github.com/RustPython/.github/blob/main/AI_POLICY.md)**.
22+
23+
If your contribution does not follow the policy, it will be closed.
24+
25+
## RustPython Development Guide and Tips
226

327
RustPython attracts developers with interest and experience in Rust, Python,
428
or WebAssembly. Whether you are familiar with Rust, Python, or

README.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -229,24 +229,10 @@ For a high level overview of the components, see the [architecture](architecture
229229

230230
## Contributing
231231

232-
Contributions are more than welcome, and in many cases we are happy to guide
233-
contributors through PRs or on Discord. Please refer to the
234-
[development guide](DEVELOPMENT.md) as well for tips on developments.
232+
Contributions are welcome and highly appreciated. To get started, check out the
233+
[**contributing guidelines**](CONTRIBUTING.md).
235234

236-
With that in mind, please note this project is maintained by volunteers, some of
237-
the best ways to get started are below:
238-
239-
Most tasks are listed in the
240-
[issue tracker](https://github.com/RustPython/RustPython/issues). Check issues
241-
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.
242-
243-
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)
244-
245-
Another approach is to checkout the source code: builtin functions and object
246-
methods are often the simplest and easiest way to contribute.
247-
248-
You can also simply run `python -I scripts/whats_left.py` to assist in finding any unimplemented
249-
method.
235+
You can also join us on [**Discord**](https://discord.gg/vru8NypEhv).
250236

251237
## Compiling to WebAssembly
252238

0 commit comments

Comments
 (0)