OMGeeky/advisory-db
1
0
Fork 0
mirror of https://github.com/OMGeeky/advisory-db.git synced 2025-12-26 16:07:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#1292)

Browse Source 
Clarify file format for creating advisory.
Explicitly mention that there should be markdown text, not just the toml.
This commit is contained in:
Vitaly Shukela
2022-08-01 22:22:38 +03:00
committed by GitHub
parent 2618960a7f
commit f6c6cd09c9
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -9,8 +9,9 @@ this repository containing the new advisory:
subdirectory of this repository (you may need to create it if it doesn't exist)
2. Copy and paste the [TOML advisory template] from the README.md file in this repo.
Delete the comments and additional whitespace, and fill it out with the
details of the advisory.
3. Open a [Pull Request]. After being reviewed your advisory will be assigned
details of the advisory. Surround the TOML data with <code>\```toml</code> and <code>\```</code> markers.
3. Write a human-readable Markdown description in the same file, after the <code>\```</code> marker and a newline. Use [this example advisory][example] as a reference.
4. Open a [Pull Request]. After being reviewed your advisory will be assigned
a `RUSTSEC-*` advisory identifier and be published to the database.
### Optional Steps
@@ -71,3 +72,4 @@ A: We do not presently handle embargoed vulnerabilities. Please ensure embargoes
[Pull Request]: https://github.com/RustSec/advisory-db/pulls
[TOML advisory template]: https://github.com/RustSec/advisory-db#advisory-format
[Yank]: https://doc.rust-lang.org/cargo/commands/cargo-yank.html
[example]: https://raw.githubusercontent.com/rustsec/advisory-db/main/EXAMPLE_ADVISORY.md