Skip to content

Commit d0695d6

Browse files
committed
docs(smart-renaming): clarify filename formatting rules
* Update guidelines for file naming conventions to ensure clarity and consistency
1 parent 1bf7bac commit d0695d6

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

.github/prompts/smart-renaming.prompt.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@ You are working on a codebase where files inside the folder $ARGUMENT need to be
22

33
### Goal:
44
1. Ensure all files in the folder are ordered in ascending alphabetical sequence based on their filename prefix.
5-
2. Each file must start with a single uppercase alphabet prefix followed by an underscore:
6-
Format: <ALPHABET> <Descriptive-name>.md
5+
2. Each file must start with a single uppercase alphabet prefix followed by an space and a descriptive name.:
6+
Format: <ALPHABET> <Descriptive Name>.md
77

88
3. If multiple files currently share the same starting alphabet, rename them so that each file gets a unique sequential alphabet.
9+
4. If the descriptive part of the filename is a interrogative add a "?" at the end of the description.
10+
5. If the descriptive part of the filename is a statement, ensure it ends with a "." at the end of the description.
911

1012
### Example:
1113
Current:

0 commit comments

Comments
 (0)