Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit dfcaf93

Browse files
docs(contributing): add Contributing TL;DR page
1 parent 4b6b3fb commit dfcaf93

File tree

3 files changed

+30
-0
lines changed

3 files changed

+30
-0
lines changed

‎docs/contributing.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ If you're a first-time contributor, you can check the issues with the [good firs
5353
```
5454
2. **Make Your Changes**
5555
- Write your code
56+
- Run `poetry format` to make sure `ruff` and `mypy` are happy
5657
- Add tests for new functionalities or fixes
5758
- Update documentation if needed
5859
- Follow the existing code style

‎docs/contributing_tldr.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Feel free to send a PR to update this file if you find anything useful. 🙇
2+
3+
## Environment
4+
5+
- Python `>=3.9`
6+
- [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) `>=2.0.0`
7+
8+
## Useful commands
9+
10+
Please check the [pyproject.toml](https://github.com/commitizen-tools/commitizen/blob/master/pyproject.toml) for a comprehensive list of commands.
11+
12+
```bash
13+
# Ensure you have the correct dependencies
14+
poetry install
15+
16+
# Make ruff happy
17+
poetry format
18+
19+
# Check if ruff and mypy are happy
20+
poetry lint
21+
22+
# Check if mypy is happy in python 3.9
23+
mypy --python-version 3.9
24+
25+
# Run tests in parallel.
26+
pytest -n auto # This may take a while.
27+
pytest -n auto <test_suite>
28+
```

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ nav:
5858
- Exit Codes: "exit_codes.md"
5959
- Third-Party Commitizen Templates: "third-party-commitizen.md"
6060
- Contributing: "contributing.md"
61+
- Contributing TL;DR: "contributing_tldr.md"
6162
- Resources: "external_links.md"
6263

6364
markdown_extensions:

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /