Skip to content

Commit e692ed5

Browse files
fix(docs): Reordered contributing guidelines in documentation
It makes more sense for optional steps to be at the end of the file
1 parent dd2a0cf commit e692ed5

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,22 @@ Significant effort SHOULD be made to give attribution for these lists whenever p
1414

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

17+
## READMEs
18+
19+
If you are uploading a brand-new wordlist into SecLists, an entry must be added to the containing folder's `README.md`. If the folder does not already have a `README.md` file, you may create one.
20+
21+
These are the general guidelines for writing READMEs in SecLists:
22+
1. Use the filename of the wordlist as the title. This will help other people more easily locate which entries in the README correspond to the wordlist you've uploaded.
23+
2. If the wordlist is very purpose-specific, consider adding a `Use for:` text, right below the entry title. For example:
24+
> ## vulnerability-scan_j2ee-websites_WEB-INF.txt
25+
> Use for: Discovering sensitive J2EE files, allowing for exploitation of an LFI.
26+
27+
3. Always include a link to the source of the wordlist: `Source: example.com/the-great-wordlist`
28+
4. If the author shared the wordlist through a blogpost, include a link to it: `Reference: example.com/how-i-hacked-xyz-with-a-wordlist`. This will help SecLists users more easily understand the practical applications of the wordlists you've uploaded.
29+
30+
You can use the README in the folder [Web-Content](Discovery/Web-Content) as a general reference.
31+
32+
1733
## Conventional Commits (optional for contributions made through Pull Requests)
1834

1935
All commits related to contributions to seclists are encouraged to use the [Conventional-Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) syntax
@@ -87,19 +103,4 @@ flowchart TD
87103
88104
q3E --> |YES| q3E_end(Use the syntax:\nchore(cicd): Fixed typo in "AUTOMATION_NAME_HERE"\nchore(cicd): Moved ______\nchode(cicd): Added code comment to "AUTOMATION_NAME_HERE")
89105
q3E --> |NO| support4(Ask a project-maintainer which commit type you should use)
90-
```
91-
92-
## READMEs
93-
94-
If you are uploading a brand-new wordlist into SecLists, an entry must be added to the containing folder's `README.md`. If the folder does not already have a `README.md` file, you may create one.
95-
96-
These are the general guidelines for writing READMEs in SecLists:
97-
1. Use the filename of the wordlist as the title. This will help other people more easily locate which entries in the README correspond to the wordlist you've uploaded.
98-
2. If the wordlist is very purpose-specific, consider adding a `Use for:` text, right below the entry title. For example:
99-
> ## vulnerability-scan_j2ee-websites_WEB-INF.txt
100-
> Use for: Discovering sensitive J2EE files, allowing for exploitation of an LFI.
101-
102-
3. Always include a link to the source of the wordlist: `Source: example.com/the-great-wordlist`
103-
4. If the author shared the wordlist through a blogpost, include a link to it: `Reference: example.com/how-i-hacked-xyz-with-a-wordlist`. This will help SecLists users more easily understand the practical applications of the wordlists you've uploaded.
104-
105-
You can use the README in the folder [Web-Content](Discovery/Web-Content) as a general reference.
106+
```

0 commit comments

Comments
 (0)