Skip to content

Commit 61b3ed6

Browse files
docs: update documentation references and fix markdown linting
1 parent ef59f04 commit 61b3ed6

2 files changed

Lines changed: 18 additions & 18 deletions

File tree

CONTRIBUTING.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,42 +5,42 @@ This document will explain how to contribute to the edit-python.pe project.
55
## How to Contribute
66

77
1. Make sure to find an open issue on [GitHub](https://github.com/python.pe/edit-python.pe/issues).
8-
2. Fork the [edit-python.pe](https://github.com/python.pe/edit-python.pe) repository.
9-
3. Clone the forked repository to your local machine.
10-
4. Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/).
11-
5. Install dependencies:
8+
1. Fork the [edit-python.pe](https://github.com/python.pe/edit-python.pe) repository.
9+
1. Clone the forked repository to your local machine.
10+
1. Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/).
11+
1. Install dependencies:
1212

1313
```bash
1414
uv sync
1515
```
1616

17-
6. Install pre-commit hook:
17+
1. Install pre-commit hook:
1818

1919
```bash
2020
uv run pre-commit install
2121
```
2222

23-
7. Make your changes.
24-
8. Cover your changes with tests.
25-
9. Run the test coverage:
23+
1. Make your changes.
24+
1. Cover your changes with tests.
25+
1. Run the test coverage:
2626

2727
```bash
28-
./test/test.sh
28+
uv run poe test
2929
```
3030

31-
10. Run the auto-translations:
31+
1. Run the auto-translations:
3232

3333
```bash
34-
./bin/translate.sh
34+
uv run poe makemessages
3535
```
3636

37-
11. Commit your changes, if the pre-commit hook fails, run `./bin/test.sh` to
37+
1. Commit your changes, if the pre-commit hook fails, run `uv run poe test` to
3838
know which test failed.
39-
12. If the last step was your last commit on this issue, run this command:
39+
1. If the last step was your last commit on this issue, run this command:
4040

4141
```bash
42-
uv run ./bin/bump-version.sh
42+
uv run poe version:update NEW_VERSION
4343
```
4444

45-
13. Push your changes to the forked repository.
46-
14. Open a pull request on [GitHub](https://github.com/python.pe/edit-python.pe/pulls).
45+
1. Push your changes to the forked repository.
46+
1. Open a pull request on [GitHub](https://github.com/python.pe/edit-python.pe/pulls).

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ uv sync
2424

2525
1. Generate a [Personal access token
2626
(classic)](https://github.com/settings/tokens).
27-
2. Grant the scope: `public_repo`.
28-
3. Copy the token and keep it handy for the command below
27+
1. Grant the scope: `public_repo`.
28+
1. Copy the token and keep it handy for the command below
2929

3030
### **For users seeking maximum speed**
3131

0 commit comments

Comments
 (0)