Skip to content

Commit a2269d0

Browse files
committed
docs: Updated CONTRIBUTING.md
1 parent 15475f5 commit a2269d0

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ Thank you for your contributions to this project!
2121
```console
2222
git clone https://github.com/JnyJny/python-package-cookiecutter
2323
cd python-package-cookiecutter
24-
uv sync
24+
uv sync --all-groups
2525
```
2626

2727
## Testing the Cookiecutter Template
2828

2929
```console
30-
pytest
3130
poe ruff
31+
pytest
3232
```
3333

3434
## Testing the Generated Project
@@ -37,14 +37,14 @@ poe ruff
3737
poe bake
3838
pushd tmp/thing
3939
pytest
40-
poe ruff
4140
popd
4241
poe clean
4342
```
4443

4544
## Documentation
4645

47-
Documentation is built using [MkDocs](https://www.mkdocs.org/) with the Material theme and deployed to GitHub Pages.
46+
Documentation is built using [MkDocs](https://www.mkdocs.org/) with
47+
the Material theme and deployed to GitHub Pages.
4848

4949
### Local Development
5050

@@ -70,9 +70,8 @@ poe docs-deploy
7070

7171
### Writing Guidelines
7272

73-
- Keep lines under 90 columns
73+
- Keep markdown lines under 90 columns
7474
- Use end links format instead of embedded URLs
75-
- Focus on concrete benefits over marketing language
7675
- Include code examples where helpful
7776
- Cross-reference related sections
7877
- Test all code examples before committing

0 commit comments

Comments
 (0)