You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
## Contributing to Stable-Baselines3 - Contrib
2
2
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
+
3
5
This contrib repository is designed for experimental implementations of various
4
6
parts of reinforcement training so that others may make use of them. This includes full
5
7
RL algorithms, different tools (e.g. new environment wrappers,
@@ -30,6 +32,8 @@ are not very strict.
30
32
See [issues with "experimental" tag](https://github.com/DLR-RM/stable-baselines3/issues?q=is%3Aissue+is%3Aopen+label%3Aexperimental)
31
33
for suggestions of the community for new possible features to include in contrib.
32
34
35
+
Note: If you do not follow the template (and its mandatory steps), your pull request will be ignored.
36
+
33
37
## How to implement your suggestion
34
38
35
39
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.
52
56
53
57
## Pull Request (PR) and review
54
58
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
+
55
61
Before proposing a PR, please open an issue, where the feature will be discussed.
56
62
This prevent from duplicated PR to be proposed and also ease the code review process.
57
63
@@ -124,7 +130,7 @@ We are using [black codestyle](https://github.com/psf/black) (max line length of
124
130
125
131
**Please run `make format`** to reformat your code. You can check the codestyle using `make check-codestyle` and `make lint`.
126
132
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:
128
134
129
135
```python
130
136
@@ -178,6 +184,6 @@ make doc
178
184
179
185
## Changelog and Documentation
180
186
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`).
182
188
183
189
Credits: this contributing guide is based on the [PyTorch](https://github.com/pytorch/pytorch/) one.
0 commit comments