Skip to content

Commit 7638261

Browse files
committed
chore: update contributing documentation
1 parent a049d6e commit 7638261

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ Issues labeled [good first issue](https://github.com/freqtrade/freqtrade/labels/
99
Few pointers for contributions:
1010

1111
- Create your PR against the `develop` branch, not `stable`.
12-
- New features need to contain unit tests, must conform to PEP8 (max-line-length = 100) and should be documented with the introduction PR.
13-
- PR's can be declared as `[WIP]` - which signify Work in Progress Pull Requests (which are not finished).
12+
- Stick to english in both commit messages, PR descriptions and code comments and variable names.
13+
- New features need to contain unit tests, must pass CI (run pre-commit and pytest to get an early feedback) and should be documented with the introduction PR.
14+
- PR's can be declared as draft - signaling Work in Progress for Pull Requests (which are not finished). We'll still aim to provide feedback on draft PR's in a timely manner.
15+
- If you're using AI for your PR, please both mention it in the PR description and do a thorough review of the generated code. The final responsibility for the code with the PR author, not with the AI.
1416

1517
If you are unsure, discuss the feature on our [discord server](https://discord.gg/p7nuUNVfP7) or in a [issue](https://github.com/freqtrade/freqtrade/issues) before a Pull Request.
1618

0 commit comments

Comments
 (0)