Skip to content

Commit 6fa2410

Browse files
authored
Update contribution guidelines regarding LLM/code assistant usage (#327)
Added important notes regarding the use of LLMs or code assistants in submissions and clarified documentation requirements.
1 parent 75fff3a commit 6fa2410

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## Contributing to Stable-Baselines3 - Contrib
22

3+
**Important: When submitting issues or pull requests, the use of LLM or code assistants (e.g., Claude or Copilot) must be publicly disclosed.**
4+
35
This contrib repository is designed for experimental implementations of various
46
parts of reinforcement training so that others may make use of them. This includes full
57
RL algorithms, different tools (e.g. new environment wrappers,
@@ -30,6 +32,8 @@ are not very strict.
3032
See [issues with "experimental" tag](https://github.com/DLR-RM/stable-baselines3/issues?q=is%3Aissue+is%3Aopen+label%3Aexperimental)
3133
for suggestions of the community for new possible features to include in contrib.
3234

35+
Note: If you do not follow the template (and its mandatory steps), your pull request will be ignored.
36+
3337
## How to implement your suggestion
3438

3539
Implement your feature/suggestion/algorithm in following ways, using the first one that applies:
@@ -52,6 +56,8 @@ calculations with references to the parts in paper.
5256

5357
## Pull Request (PR) and review
5458

59+
**Important: We do not accept PRs that are fully generated using an LLM/code assistant unless triggered by a maintainer. Use of code assistants (e.g., Claude, Copilot) must be publicly disclosed.**
60+
5561
Before proposing a PR, please open an issue, where the feature will be discussed.
5662
This prevent from duplicated PR to be proposed and also ease the code review process.
5763

@@ -124,7 +130,7 @@ We are using [black codestyle](https://github.com/psf/black) (max line length of
124130
125131
**Please run `make format`** to reformat your code. You can check the codestyle using `make check-codestyle` and `make lint`.
126132
127-
Please document each function/method and [type](https://google.github.io/pytype/user_guide.html) them using the following template:
133+
Please document each function/method and [type](https://mypy-lang.org/) them using the following template:
128134
129135
```python
130136
@@ -178,6 +184,6 @@ make doc
178184

179185
## Changelog and Documentation
180186

181-
Please do not forget to update the changelog (`docs/misc/changelog.rst`).
187+
Please do not forget to update the changelog (`docs/misc/changelog.md`).
182188

183189
Credits: this contributing guide is based on the [PyTorch](https://github.com/pytorch/pytorch/) one.

0 commit comments

Comments
 (0)