Skip to content

Commit 93ef2f7

Browse files
committed
Update CONTRIBUTING.md
1 parent 82e77cf commit 93ef2f7

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,15 @@ Where `<category>` is one of the existing categories, for example:
5050
}
5151
```
5252

53+
For a Pull Request it is **enough to add a correct JSON file** in the appropriate `projects/<category>/` directory.
54+
55+
If you want to **preview and verify** how your project will look in the README before opening a PR, you can run the generator locally as described below.
56+
5357
---
5458

55-
## 3. Regenerating the README Locally
59+
## 3. Regenerating the README Locally (optional)
60+
61+
If you want to preview how your project will look in the README **before** opening a PR:
5662

5763
1. Make sure you have Python 3 installed.
5864
2. From the repository root, run:
@@ -68,6 +74,8 @@ Where `<category>` is one of the existing categories, for example:
6874
- For GitHub projects, badges are shown
6975
- For non‑GitHub projects, there are no GitHub badges
7076

77+
These local steps are **optional** and only for your own preview. The README in the main branch will be regenerated by GitHub Actions after your PR is merged.
78+
7179
---
7280

7381
## 4. Opening a Pull Request
@@ -79,22 +87,16 @@ Where `<category>` is one of the existing categories, for example:
7987
git checkout -b add-my-project
8088
```
8189

82-
3. Add your JSON file under `projects/<category>/<project_name>`.
83-
4. Run the README generator:
84-
85-
```bash
86-
python scripts/generate_readme.py
87-
```
88-
89-
5. Commit and push:
90+
3. Add your JSON file under `projects/<category>/<project_name>.json`.
91+
4. Commit and push your changes:
9092

9193
```bash
92-
git add projects/**/*.json README.md
94+
git add projects/**/*.json
9395
git commit -m "Add <Project Name> to <Category>"
9496
git push origin add-my-project
9597
```
9698

97-
6. Open a Pull Request and briefly describe your project and chosen category.
99+
5. Open a Pull Request and briefly describe your project and chosen category.
98100

99101

100102
## Join the Open Source Community
@@ -107,7 +109,7 @@ If you want to:
107109
- find collaborators,
108110
- get feedback on your own project,
109111

110-
join us on Telegram:
112+
Join us on Community in Telegram:
111113

112114
<a href="https://t.me/OpenSource_Chat">
113115
<img src='assets/join.svg'/>

0 commit comments

Comments
 (0)