Update repository spec

- Move CoC and contributing to templates directory - Create security template - Modify repository to address feedback Addresses open-telemetry#9 open-telemetry#10
rockb1017 · Mar 31, 2021 · bef81c1 · bef81c1
1 parent 3e66ff1
commit bef81c1
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 4 deletions.
diff --git a/docs/repository.md b/docs/repository.md
@@ -6,19 +6,21 @@ it can release a `1.0.0` version.
 ## Required Files
 
 - MUST have a `CHANGELOG.md` updated for every release
-- MUST add the [CODE_OF_CONDUCT](CODE_OF_CONDUCT)
-- MUST add the [CONTRIBUTING.md](CONTRIBUTING.md)
+- MUST add the [templates/CODE_OF_CONDUCT](CODE_OF_CONDUCT)
+- MUST add the [templates/CONTRIBUTING.md](CONTRIBUTING.md)
 - MUST have a `.github/CODEOWNERS` file with at least two currently full-time Splunkers listed
-  - MUST NOT have any not currently full-time Splunkers listed in `.github/CODEOWNERS`
+  - MUST NOT have any non-full-time Splunkers listed in `.github/CODEOWNERS`
 - MUST have an Apache 2.0 `LICENSE` file
-- MUST have a `MIGRATING.md`
+- SHOULD have a `MIGRATING.md` if applicable
 - MUST have a `README.md`
   - MUST have badges on `README.md` with code coverage and build status
   - SHOULD have badges on `README.md` for other relevant things including artifacts
   - MUST have getting started information in `README.md`
   - MUST have troubleshooting information in `README.md`
   - MUST have license information in `README.md`
 - MUST have a `RELEASE.md` documenting the release process
+- MUST add the [templates/SECURITY.md](SECURITY.md)
+- SHOULD add dependabot information to SECURITY.md if applicable
 
 ## Required Configuration
 

diff --git a/docs/CODE_OF_CONDUCT.md → docs/templates/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md → docs/templates/CODE_OF_CONDUCT.md
diff --git a/docs/CONTRIBUTING.md → docs/templates/CONTRIBUTING.md b/docs/CONTRIBUTING.md → docs/templates/CONTRIBUTING.md
diff --git a/docs/templates/SECURITY.md b/docs/templates/SECURITY.md
@@ -0,0 +1,7 @@
+# Security
+
+## Reporting Security Issues
+
+Please *DO NOT* report security vulnerabilities with public GitHub issue
+reports. Please [report security issues here](
+https://www.splunk.com/en_us/product-security/report.html).