Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
repos:
- repo: local
hooks:
- id: testing
name: Testing
description: Running tests for the app
language: python
entry: ./bin/test.sh

default_stages: [pre-commit, pre-push]
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Developer Guide

This document will explain how to contribute to the edit-python.pe project.

## How to Contribute

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

```bash
uv sync
```

6. Install pre-commit hook:

```bash
uv run pre-commit install
```

7. Make your changes.
8. Cover your changes with tests.
9. Run the test coverage:

```bash
./test/test.sh
```

8. Commit your changes, if the pre-commit hook fails, run `./bin/test.sh` to
know which test failed.
9. If the last step was your last commit on this issue, run this command:

```bash
uv run ./bin/bump-version.sh
```

10. Push your changes to the forked repository.
11. Open a pull request on [GitHub](https://github.com/python.pe/edit-python.pe/pulls).
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "edit-python-pe"
version = "0.2.2"
version = "0.2.3"
description = "Allows member and project profile editing onto python.pe git repository"
readme = "README.md"
authors = [
Expand Down Expand Up @@ -54,6 +54,7 @@ dev = [
"deep-translator>=1.11.4",
"isort>=6.0.1",
"polib>=1.2.0",
"pre-commit>=4.3.0",
"pytest>=8.4.1",
"pytest-cov>=6.2.1",
"textual-dev==1.7.0",
Expand Down
149 changes: 148 additions & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.