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
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,9 +50,15 @@ Where `<category>` is one of the existing categories, for example:
50
50
}
51
51
```
52
52
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
+
53
57
---
54
58
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:
56
62
57
63
1. Make sure you have Python 3 installed.
58
64
2. From the repository root, run:
@@ -68,6 +74,8 @@ Where `<category>` is one of the existing categories, for example:
68
74
- For GitHub projects, badges are shown
69
75
- For non‑GitHub projects, there are no GitHub badges
70
76
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
+
71
79
---
72
80
73
81
## 4. Opening a Pull Request
@@ -79,22 +87,16 @@ Where `<category>` is one of the existing categories, for example:
79
87
git checkout -b add-my-project
80
88
```
81
89
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:
90
92
91
93
```bash
92
-
git add projects/**/*.json README.md
94
+
git add projects/**/*.json
93
95
git commit -m "Add <Project Name> to <Category>"
94
96
git push origin add-my-project
95
97
```
96
98
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.
0 commit comments