Skip to content

Commit 6208808

Browse files
committed
docs: clarify usage examples requirement in README.md instructions
1 parent 7e2f0b5 commit 6208808

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ When adding new scripts to any directory:
1717
- Always add an entry to the appropriate `README.md` file in alphabetical order
1818
- Follow the existing format and structure in the README
1919
- Include a clear description, usage examples, and any prerequisites/notes
20+
- We don't need both usage AND an example of running the script - just one please
2021
- Use proper kebab-case naming convention for script files
2122
- Avoid short words like "repo" (use "repository"), "org" (use "organization")
2223
- Test that the entry passes `lint-readme.js` validation

.github/prompts/add-script-to-readme.prompt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Each script entry must include:
3535

3636
- **Heading**: `### script-name.sh` (or appropriate extension)
3737
- **Description**: Brief explanation of what the script does
38-
- **Usage examples**: If applicable, show how to run the script
38+
- **Usage examples**: If applicable, show how to run the script (We don't need both usage AND an example of running the script - just one please)
3939
- **Notes/Warnings**: Any important information about prerequisites, permissions, or limitations
4040

4141
### 4. File Existence

0 commit comments

Comments
 (0)