diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 50e193e1..20018a9f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,22 @@ Significant effort SHOULD be made to give attribution for these lists whenever p Folders should be named with the train case scheme, for example `File-System`. +## READMEs + +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. + +These are the general guidelines for writing READMEs in SecLists: +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. +2. If the wordlist is very purpose-specific, consider adding a `Use for:` text, right below the entry title. For example: +> ## vulnerability-scan_j2ee-websites_WEB-INF.txt +> Use for: Discovering sensitive J2EE files, allowing for exploitation of an LFI. + +3. Always include a link to the source of the wordlist: `Source: example.com/the-great-wordlist` +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. + +You can use the README in the folder [Web-Content](Discovery/Web-Content) as a general reference. + + ## Conventional Commits (optional for contributions made through Pull Requests) 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 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") q3E --> |NO| support4(Ask a project-maintainer which commit type you should use) -``` - -## READMEs - -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. - -These are the general guidelines for writing READMEs in SecLists: -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. -2. If the wordlist is very purpose-specific, consider adding a `Use for:` text, right below the entry title. For example: -> ## vulnerability-scan_j2ee-websites_WEB-INF.txt -> Use for: Discovering sensitive J2EE files, allowing for exploitation of an LFI. - -3. Always include a link to the source of the wordlist: `Source: example.com/the-great-wordlist` -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. - -You can use the README in the folder [Web-Content](Discovery/Web-Content) as a general reference. +``` \ No newline at end of file