Skip to content

Commit 50818f3

Browse files
feat(docs): Updated contribution guidelines
1 parent 2179ef6 commit 50818f3

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Significant effort SHOULD be made to give attribution for these lists whenever p
1212

1313
## Wordlist content
1414

15-
If you're uploading a new Wordlist, make sure to follow these guidelines.
15+
If you're adding new content to a wordlist or creating a new one, make sure to follow these guidelines.
1616

1717
### Remove leading slashes
1818
Do not include leading slashes in the wordlists contents. This ensures all SecLists wordlists have the same format, and also helps keep the wordlist filesize down.
@@ -47,6 +47,13 @@ For example:
4747
-`path/to/auth?password={PASSWORD_PLACEHOLDER}`
4848

4949

50+
### Remove in-file comments and put them in the documentation
51+
52+
Most users of SecLists expect the wordlists to be ready to use unless otherwise stated. For that reason, wordlists should never contain comments such as lines beginning with `//` or `#` for the purposes of commentary.
53+
54+
If certain content within the wordlist requires an explanation, it's recommended to place those explanations in the `README.md` of the relevant directory, along with any other relevant explanations (such as placeholders).
55+
56+
5057
## Folder naming scheme
5158

5259
Folders should be named with the train case scheme, for example `File-System`.

0 commit comments

Comments
 (0)