Skip to content

Commit a6b3b9d

Browse files
committed
CONTRIBUTING page updates - adding rules
1 parent f333d48 commit a6b3b9d

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ In order to provide the safest payloads for the community, the following rules m
1717
- Use `Administrator` for privileged users and `User` for normal account
1818
- Use `P@ssw0rd`, `Password123`, `password` as default passwords for your examples
1919
- Prefer commonly used name for machines such as `DC01`, `EXCHANGE01`, `WORKSTATION01`, etc
20-
- References must have an `author`, a `title` and a `link`. The `date` is not mandatory but appreciated :)
20+
- References must have an `author`, a `title`, a `link` and a `date`
21+
- Use [Wayback Machine](wayback.archive.org) if the reference is not available anymore.
22+
- The date must be following the format `Month Number, Year`, e.g: `December 25, 2024`
23+
- References to Github repositories must follow this format: `[author/tool](https://github.com/URL) - Description`
2124

2225
Every pull request will be checked with `markdownlint` to ensure consistent writing and Markdown best practices. You can validate your files locally using the following Docker command:
2326

@@ -29,11 +32,16 @@ docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.15.0 "**/*.md" --con
2932

3033
Every section should contains the following files, you can use the `_template_vuln` folder to create a new technique folder:
3134

32-
- README.md - vulnerability description and how to exploit it, including several payloads, more below
33-
- Intruder - a set of files to give to Burp Intruder
34-
- Images - pictures for the README.md
35-
- Files - some files referenced in the README.md
35+
- **README.md**: vulnerability description and how to exploit it, including several payloads, more below
36+
- **Intruder**: a set of files to give to Burp Intruder
37+
- **Images**: pictures for the README.md
38+
- **Files**: some files referenced in the README.md
3639

37-
## README.md format
40+
## README.md Format
3841

39-
Use the example folder [_template_vuln/](https://github.com/swisskyrepo/PayloadsAllTheThings/blob/master/_template_vuln/). The main page is [README.md](https://github.com/swisskyrepo/PayloadsAllTheThings/blob/master/_template_vuln/README.md).
42+
Use the example folder [_template_vuln/](https://github.com/swisskyrepo/PayloadsAllTheThings/blob/master/_template_vuln/) to create a new vulnerability document. The main page is [README.md](https://github.com/swisskyrepo/PayloadsAllTheThings/blob/master/_template_vuln/README.md). It is organized with sections for a title and description of the vulnerability, along with a summary table of contents linking to the main sections of the document.
43+
44+
- **Tools**: Lists relevant tools with links to their repositories and brief descriptions.
45+
- **Methodology**: Provides a quick overview of the approach used, with code snippets to demonstrate exploitation steps.
46+
- **Labs**: References online platforms where similar vulnerabilities can be practiced, each with a link to the corresponding lab.
47+
- **References**: Lists external resources, such as blog posts or articles, providing additional context or case studies related to the vulnerability.

Zip Slip/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,5 @@ For affected libraries and projects, visit [snyk/zip-slip-vulnerability](https:/
4848

4949
## References
5050

51-
- [Zip Slip - Snyk - Jun 5, 2018](https://github.com/snyk/zip-slip-vulnerability)
51+
- [Zip Slip - Snyk - June 5, 2018](https://github.com/snyk/zip-slip-vulnerability)
5252
- [Zip Slip Vulnerability - Snyk - April 15, 2018](https://snyk.io/research/zip-slip-vulnerability)

0 commit comments

Comments
 (0)