Skip to content

Commit ae3ac0c

Browse files
authored
Adding CONTRIBUTING.md and pre-commit hook (#45)
* adding CONTRIBUTING.md and pre-commit hook, fixess #44 * bump version to 0.2.3
1 parent 38746e0 commit ae3ac0c

File tree

4 files changed

+200
-2
lines changed

4 files changed

+200
-2
lines changed

.pre-commit-config.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
repos:
2+
- repo: local
3+
hooks:
4+
- id: testing
5+
name: Testing
6+
description: Running tests for the app
7+
language: python
8+
entry: ./bin/test.sh
9+
10+
default_stages: [pre-commit, pre-push]

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Developer Guide
2+
3+
This document will explain how to contribute to the edit-python.pe project.
4+
5+
## How to Contribute
6+
7+
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:
12+
13+
```bash
14+
uv sync
15+
```
16+
17+
6. Install pre-commit hook:
18+
19+
```bash
20+
uv run pre-commit install
21+
```
22+
23+
7. Make your changes.
24+
8. Cover your changes with tests.
25+
9. Run the test coverage:
26+
27+
```bash
28+
./test/test.sh
29+
```
30+
31+
8. Commit your changes, if the pre-commit hook fails, run `./bin/test.sh` to
32+
know which test failed.
33+
9. If the last step was your last commit on this issue, run this command:
34+
35+
```bash
36+
uv run ./bin/bump-version.sh
37+
```
38+
39+
10. Push your changes to the forked repository.
40+
11. Open a pull request on [GitHub](https://github.com/python.pe/edit-python.pe/pulls).

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "edit-python-pe"
3-
version = "0.2.2"
3+
version = "0.2.3"
44
description = "Allows member and project profile editing onto python.pe git repository"
55
readme = "README.md"
66
authors = [
@@ -54,6 +54,7 @@ dev = [
5454
"deep-translator>=1.11.4",
5555
"isort>=6.0.1",
5656
"polib>=1.2.0",
57+
"pre-commit>=4.3.0",
5758
"pytest>=8.4.1",
5859
"pytest-cov>=6.2.1",
5960
"textual-dev==1.7.0",

uv.lock

Lines changed: 148 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)