You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-20Lines changed: 21 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,19 @@
1
-
Here is a comprehensive `CONTRIBUTING.md` tailored for your repository. It incorporates the specific tools (Black, Pylint, MyPy, Flake8) and the release workflow we discussed.
2
-
3
-
-----
4
-
5
1
# Contributing to Python Linting Action
6
2
7
3
First off, thank you for considering contributing to this project\! It's people like you that make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
3. **Create a new branch**for your feature or fix:
14
+
15
+
3. **Create a new branch**for your feature or fix:
16
+
18
17
```bash
19
18
git checkout -b feature/amazing-new-feature
20
19
```
@@ -25,9 +24,9 @@ First off, thank you for considering contributing to this project\! It's people
25
24
26
25
We want to keep the codebase clean and consistent. Before submitting your code, please ensure it passes the same quality checks that this Action enforces:
27
26
28
-
***Formatting:** We use [Black](https://github.com/psf/black).
29
-
***Linting:** We use [Pylint](https://pylint.pycqa.org/) and [Flake8](https://flake8.pycqa.org/).
30
-
***Type Checking:** We use [MyPy](https://mypy-lang.org/).
27
+
***Formatting:** We use [Black](https://github.com/psf/black).
28
+
***Linting:** We use [Pylint](https://pylint.pycqa.org/) and [Flake8](https://flake8.pycqa.org/).
29
+
***Type Checking:** We use [MyPy](https://mypy-lang.org/).
31
30
32
31
You can run these tools locally to verify your changes:
33
32
@@ -43,19 +42,21 @@ flake8 .
43
42
44
43
**Crucial Step:** All substantive changes (features, fixes, breaking changes) must be documented.
45
44
46
-
* Open `CHANGELOG.md`.
47
-
* Add a bullet point describing your change under the `[Unreleased]` section.
48
-
* Follow the format: `* Description of change (@your-username)`
45
+
* Open `CHANGELOG.md`.
46
+
* Add a bullet point describing your change under the `[Unreleased]` section.
47
+
* Follow the format: `* Description of change (@your-username)`
49
48
50
49
## 📮 Submitting a Pull Request
51
50
52
-
1. **Push your branch** to GitHub:
51
+
1. **Push your branch** to GitHub:
52
+
53
53
```bash
54
54
git push origin feature/amazing-new-feature
55
55
```
56
-
2. **Open a Pull Request** against the `main` branch.
57
-
3. **Fill out the PR Template:** Describe your changes clearly and link to any relevant issues (e.g., `Fixes #123`).
58
-
4. **Wait for CI:** Ensure all GitHub Actions workflows (Tests, Linting, Changelog Check) pass.
56
+
57
+
2. **Open a Pull Request** against the `main` branch.
58
+
3. **Fill out the PR Template:** Describe your changes clearly and link to any relevant issues (e.g., `Fixes #123`).
59
+
4. **Wait for CI:** Ensure all GitHub Actions workflows (Tests, Linting, Changelog Check) pass.
59
60
60
61
-----
61
62
@@ -67,9 +68,9 @@ This repository uses a specific workflow to handle semantic versioning and "floa
67
68
68
69
When a PR is merged to `main` with a valid `CHANGELOG.md` entry:
69
70
70
-
1. The system automatically detects the version bump.
71
-
2. A new release is created with notes from the changelog.
72
-
3. The major version tag (e.g., `v1`) is automatically moved to the new release.
71
+
1. The system automatically detects the version bump.
72
+
2. A new release is created with notes from the changelog.
73
+
3. The major version tag (e.g., `v1`) is automatically moved to the new release.
0 commit comments