From e2070dc5513f27b9eedf47025204819c93289180 Mon Sep 17 00:00:00 2001 From: Lcerkov <96153185+Lcerkov@users.noreply.github.com> Date: Mon, 10 Jan 2022 11:02:34 -0700 Subject: [PATCH] Update PULL-EXAMPLE.md --- PULL-EXAMPLE.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/PULL-EXAMPLE.md b/PULL-EXAMPLE.md index 253c3f4..815ec69 100644 --- a/PULL-EXAMPLE.md +++ b/PULL-EXAMPLE.md @@ -7,7 +7,7 @@ products that have official advisories or alerts that verify the product's vulnerability status to [CVE-2021-4104](https://nvd.nist.gov/vuln/detail/cve-2021-4104), [CVE-2021-44228](https://nvd.nist.gov/vuln/detail/CVE-2021-44228), [CVE-2021-45046](https://nvd.nist.gov/vuln/detail/CVE-2021-45046), -and/or [CVE-2021-45105.](https://nvd.nist.gov/vuln/detail/CVE-2021-45105?s=09). +and/or [CVE-2021-45105](https://nvd.nist.gov/vuln/detail/CVE-2021-45105?s=09). **Step 1:** Go to the cisagov data .yml files and choose the appropriate file to include your updates (example link). The files are separated alphabetically @@ -53,15 +53,14 @@ Blank template: last_updated: '' ``` -**Step 3:** Verify the new entry was entered before and/or after the prior and +**Step 4:** Verify the new entry was entered before and/or after the prior and next entries. +* If you are adding it to the beginning of the file, ensure you are pasting +it after `software:` and before the next entry starting with `- vendor:`. +* If you are adding it to the end of the file, ensure the entry ends before +the file is closed out with `...`. - - If you are adding it to the beginning of the file, ensure you are pasting - it after `software:` and before the next entry starting with `- vendor:`. - - If you are adding it to the end of the file, ensure the entry ends before - the file is closed out with `...`. - -**Step 4:** When you add content to the file, remove the `''` or `[]` for fields +**Step 5:** When you add content to the file, remove the `''` or `[]` for fields which are replaced with values (strings `''` or lists `[]` should be replaced as shown in the example below, with list values on the following line(s) starting with hyphen(s) `-`). The symbols should only remain used when fields remain @@ -108,7 +107,7 @@ Entry example: last_updated: '2021-12-14T00:00:00' ``` -**Step 5:** Validate that your data follows the appropriate format and proceed +**Step 6:** Validate that your data follows the appropriate format and proceed with submitting the pull request. For any additional questions feel free to [submit an Issue request](https://github.com/cisagov/log4j-affected-db/issues).