Skip to content

Commit 7746407

Browse files
authored
github: mention all three generated resources
1 parent 9c71cfa commit 7746407

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,24 @@ Thumbnail is **required** for every tool.
6464

6565
---
6666

67-
## Stars and READMEs (Auto-Generated)
67+
## Auto-Generated Metadata
6868

69-
The following files are **automatically managed**:
69+
The following files are **automatically generated and managed by CI**:
7070

7171
- `metadata/stars.json`
7272
- Updated daily at **00:00 UTC**
73+
- Contains the latest GitHub star counts for each tool
74+
75+
- `metadata/repo_stats.json`
76+
- Generated by the metadata synchronization workflow
77+
- Includes repository statistics such as **forks, issues, pull requests, license, and last update timestamp**
78+
7379
- `metadata/readme/{tool.id}.md`
74-
- Fetched directly from upstream GitHub repositories
80+
- README files fetched directly from the upstream GitHub repositories
81+
- Badges are stripped and relative links are rewritten
7582

76-
**Do NOT edit these files in pull requests.**
83+
**Do NOT edit these files in pull requests.**
84+
Any manual changes will be overwritten by the CI workflow.
7785

7886
---
7987

0 commit comments

Comments
 (0)