mirror of
https://github.com/apsdehal/awesome-ctf
synced 2024-11-24 19:33:09 +00:00
Add CONTRIBUTING.md
This commit is contained in:
parent
77ab28ec90
commit
889b5bde7d
2 changed files with 25 additions and 1 deletions
24
CONTRIBUTING.md
Normal file
24
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
# Contribution Guidelines
|
||||
|
||||
- **To add to the list:** Submit a pull request
|
||||
- **To remove from the list:** Open an issue
|
||||
|
||||
- List items should be sorted *alphabetically*.
|
||||
- Each item should be limited to one link
|
||||
- The link should be the name of the package or project
|
||||
- Direct installation commands should follow on the next line, indented by 2 spaces and enclosed in \`\`
|
||||
- Descriptions should be clear, concise, and non-promotional
|
||||
- Descriptions should follow the link, on the same line
|
||||
|
||||
## Quality standard
|
||||
|
||||
To stay on the list, package repositories should adhere to these quality standards:
|
||||
|
||||
- Generally useful to the community
|
||||
- Functional
|
||||
- Stable
|
||||
|
||||
|
||||
## Reporting issues
|
||||
|
||||
Please open an issue if you find anything that could be improved or have suggestions for making the list a more valuable resource. Thanks!
|
|
@ -4,7 +4,7 @@ A curated list of CTF frameworks, libraries, resources and softwares.
|
|||
|
||||
### Contributing
|
||||
|
||||
Please take a quick gander at the [contribution guidelines](https://github.com/apsdehal/ctf-tools/CONTRIBUTING.md) first.
|
||||
Please take a quick look at the [contribution guidelines](https://github.com/apsdehal/ctf-tools/CONTRIBUTING.md) first.
|
||||
|
||||
#### _If you know a tool that isn't present here, feel free to open a pull request._
|
||||
|
||||
|
|
Loading…
Reference in a new issue