From 678be1e1ec34db3d8e79441f8b7e5fc6a7b3a19e Mon Sep 17 00:00:00 2001 From: "Ignacio J. Perez Portal" <5990@protonmail.com> Date: Mon, 29 Apr 2024 08:02:17 -0300 Subject: [PATCH 1/2] feat(docs): Created more specific guidelines for writing documentation effectively --- CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e19ca37eb2..bd2b1a29582 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,15 @@ Folders should be named with the train case scheme, for example `File-System`. ## READMEs -`README.md` should ideally be written whenever needed. For example, if you are adding folders into SecLists you should add a readme into the folder to describe the contents. +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. -You can use the folder [PHP-Hashes](Passwords/PHP-Hashes/) as a reference. +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. From 8b82f74ee9768cd5f7ea5a54797112f0a2d27c9d Mon Sep 17 00:00:00 2001 From: "Ignacio J. Perez Portal" <5990@protonmail.com> Date: Mon, 29 Apr 2024 08:09:03 -0300 Subject: [PATCH 2/2] fix(docs): Improved PR template - Removed non-sensical note about creating an issue to track a pull request - Added note about checking the CONTRIBUTING.md before creating a pull request --- .github/PULL_REQUEST_TEMPLATE/pull_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request.md b/.github/PULL_REQUEST_TEMPLATE/pull_request.md index 04796a95a3d..7c0c6fb965e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request.md @@ -7,7 +7,7 @@ assignees: '' --- - + **Describe the added commits**