Skip to content

Commit ba06109

Browse files
Refactor CONTRIBUTING.md for improved clarity and consistency in formatting
1 parent e920a2d commit ba06109

1 file changed

Lines changed: 21 additions & 20 deletions

File tree

CONTRIBUTING.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff 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-
51
# Contributing to Python Linting Action
62

73
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**.
84

95
## 🚀 Getting Started
106

11-
1. **Fork the repository** on GitHub.
12-
2. **Clone your fork** locally:
7+
1. **Fork the repository** on GitHub.
8+
2. **Clone your fork** locally:
9+
1310
```bash
1411
git clone https://github.com/your-username/python-linting.git
1512
cd python-linting
1613
```
17-
3. **Create a new branch** for your feature or fix:
14+
15+
3. **Create a new branch** for your feature or fix:
16+
1817
```bash
1918
git checkout -b feature/amazing-new-feature
2019
```
@@ -25,9 +24,9 @@ First off, thank you for considering contributing to this project\! It's people
2524

2625
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:
2726

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/).
3130

3231
You can run these tools locally to verify your changes:
3332

@@ -43,19 +42,21 @@ flake8 .
4342

4443
**Crucial Step:** All substantive changes (features, fixes, breaking changes) must be documented.
4544

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)`
4948

5049
## 📮 Submitting a Pull Request
5150

52-
1. **Push your branch** to GitHub:
51+
1. **Push your branch** to GitHub:
52+
5353
```bash
5454
git push origin feature/amazing-new-feature
5555
```
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.
5960

6061
-----
6162

@@ -67,9 +68,9 @@ This repository uses a specific workflow to handle semantic versioning and "floa
6768

6869
When a PR is merged to `main` with a valid `CHANGELOG.md` entry:
6970

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.
7374

7475
### Manual Release / Tag Correction
7576

0 commit comments

Comments
 (0)