ayrisdev/app-store-optimization
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: refine MAINTENANCE.md with detailed README instructions

Browse Source
This commit is contained in:
sck_0
2026-01-16 18:00:44 +01:00
parent 98756d75ae
commit 68a457b96b
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
MAINTENANCE.md
View File

@@ -7,6 +7,7 @@ To ensure consistency and quality, the following steps MUST be performed for **e
- [ ] **Check Duplicates**: Before adding a skill, check `skills_index.json` or `ls skills/` to ensure it doesn't exist. - [ ] **Check Duplicates**: Before adding a skill, check `skills_index.json` or `ls skills/` to ensure it doesn't exist.
- [ ] **Folder Structure**: Each skill must have its own folder in `skills/<skill-name>`. - [ ] **Folder Structure**: Each skill must have its own folder in `skills/<skill-name>`.
- [ ] **SKILL.md**: Every skill directory MUST contain a `SKILL.md` file with valid frontmatter: - [ ] **SKILL.md**: Every skill directory MUST contain a `SKILL.md` file with valid frontmatter:
```markdown ```markdown
--- ---
name: Skill Name name: Skill Name
@@ -19,10 +20,13 @@ To ensure consistency and quality, the following steps MUST be performed for **e
Running the scripts is **MANDATORY** after any change to `skills/`. Running the scripts is **MANDATORY** after any change to `skills/`.
- [ ] **Validate Skills**: Run the validation script to check for formatting errors. - [ ] **Validate Skills**: Run the validation script to check for formatting errors.
```bash ```bash
python3 scripts/validate_skills.py python3 scripts/validate_skills.py
``` ```
- [ ] **Generate Index**: Update `skills_index.json`. This is the source of truth for the agent. - [ ] **Generate Index**: Update `skills_index.json`. This is the source of truth for the agent.
```bash ```bash
python3 scripts/generate_index.py python3 scripts/generate_index.py
``` ```
@@ -31,12 +35,15 @@ Running the scripts is **MANDATORY** after any change to `skills/`.
The `README.md` does not auto-update. You must manually sync it with the index. The `README.md` does not auto-update. You must manually sync it with the index.
- [ ] **Update Skill Count**: Check the output of `generate_index.py` (e.g., "Generated index with 131 skills") and update the badge/text in `README.md`. - [ ] **About / Introduction**: Update the total count in the opening paragraph and blockquote.
- Line ~3: `> **The Ultimate Collection of [NUMBER]+ Agentic Skills...` - `> **The Ultimate Collection of [X]+ Agentic Skills...`
- Line ~9: `...library of **[NUMBER] high-performance skills**...` - `...library of **[X] high-performance skills**...`
- Line ~39: `## Full Skill Registry ([NUMBER]/[NUMBER])` - [ ] **Features & Categories Table**: If the new skill fits a category, update the table in `# Features & Categories`.
- [ ] **Update Registry Table**: If new skills were added, add them to the alphabetical table in `README.md`. - [ ] **Full Skill Registry Table**: Add the new skill to the main table.
- [ ] **Update Categories**: If the skill fits a specific category (e.g., Security, Design), update the "Features & Categories" table. - Format: `| **[Name]** | [Description] | [Path] |`
- Verify alphabetical order.
- [ ] **Credits & Sources**: If the skill was imported from a community repo, add a credit link in `# Credits & Sources`.
- Example: `- **[repo-name](url)**: Source for [skill-name].`
## 4. Git Operations ## 4. Git Operations