Skip to content

Commit 99360ad

Browse files
committed
docs: add contributing for nix users
1 parent 6a2c806 commit 99360ad

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

docs/contributing.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If you're a first-time contributor, please check out issues labeled [good first
3838
```bash
3939
git remote add upstream https://github.com/commitizen-tools/commitizen.git
4040
```
41-
4. Set up the development environment:
41+
4. Set up the development environment (nix users go to [nix section](#nix)):
4242
```bash
4343
poetry install
4444
```
@@ -70,6 +70,7 @@ If you're a first-time contributor, please check out issues labeled [good first
7070
5. **Documentation**
7171
- Update `docs/README.md` if needed
7272
- For CLI help screenshots: `poetry doc:screenshots`
73+
- Prefer [Google style documentation](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings), which works well with editors like VSCode and PyCharm
7374
- **DO NOT** update `CHANGELOG.md` (automatically generated)
7475
- **DO NOT** update version numbers (automatically handled)
7576
6. **Pull Request**
@@ -153,3 +154,16 @@ flowchart TD
153154
--modification-received-->
154155
review
155156
```
157+
158+
## Nix
159+
160+
If you have installed poetry globally, the project won't work because it requries `poethepoet` for command management.
161+
162+
You'll have to install poetry locally.
163+
164+
```sh
165+
python -m venv .venv
166+
. .venv/bin/activate
167+
pip install -U pip && pip install poetry
168+
poetry install
169+
```

docs/contributing_tldr.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Please check the [pyproject.toml](https://github.com/commitizen-tools/commitizen
1212
### Code Changes
1313

1414
```bash
15-
# Ensure you have the correct dependencies
15+
# Ensure you have the correct dependencies, for nix user's see below
1616
poetry install
1717

1818
# Make ruff happy
@@ -35,3 +35,14 @@ pytest -n auto <test_suite>
3535
# Build the documentation locally and check for broken links
3636
poetry doc
3737
```
38+
39+
### Nix Users
40+
41+
If you are using Nix, you can install poetry locally by running:
42+
43+
```sh
44+
python -m venv .venv
45+
. .venv/bin/activate
46+
pip install -U pip && pip install poetry
47+
poetry install
48+
```

0 commit comments

Comments
 (0)