From 3ba680d47a6ddfcc743fbb8d1a5bda439b2b6f8a Mon Sep 17 00:00:00 2001 From: Nate Scherer <376408+natescherer@users.noreply.github.com> Date: Sat, 28 Oct 2023 02:27:10 -0400 Subject: [PATCH] Improve doc --- .github/dependabot.yml | 1 + CODE_OF_CONDUCT.md | 5 ++--- CONTRIBUTING.md | 24 +++++++++--------------- SECURITY.md | 17 +++++++++++++++++ 4 files changed, 29 insertions(+), 18 deletions(-) create mode 100644 SECURITY.md diff --git a/.github/dependabot.yml b/.github/dependabot.yml index e33811f..e704e57 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,3 +5,4 @@ updates: directory: "/" schedule: interval: "monthly" + open-pull-requests-limit: 100 \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index c3e5b8a..062e24b 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,4 +1,3 @@ - # Contributor Covenant Code of Conduct ## Our Pledge @@ -60,7 +59,8 @@ representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement via GitHub Issues. +reported to the community leaders responsible for enforcement via the built-in +GitHub vulnerability reporting on the Security tab. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the @@ -130,4 +130,3 @@ For answers to common questions about this code of conduct, see the FAQ at [Mozilla CoC]: https://github.com/mozilla/diversity [FAQ]: https://www.contributor-covenant.org/faq [translations]: https://www.contributor-covenant.org/translations - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf1d400..8aa7a1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,38 +14,32 @@ If I accept your contribution, I'll add you to the Authors section in the README ## How to Contribute -If you would like to make a simple contribution (a few lines or less), please put it in an Issue with the "contribution" label. - -For larger contributions, please fork this project, make the changes/additions, and then issue a Pull Request. +For contributions, please fork this project, make the changes/additions, and then issue a Pull Request. Never done a pull request before? There's an easy tutorial [here](http://makeapullrequest.com/). ## How to report a bug ### Vulnerabilities -If you find a security vulnerability, please do NOT open an Issue. Instead, email security@REPLACE-THIS-WITH-MY-GITHUB-USERNAME.com +If you find a security vulnerability, please do NOT open an Issue. Instead, see [SECURITY.md](SECURITY.md) ### Non-Security Bugs -For non-security bugs, please open a GitHub issue with the "bug" label containing the following information: +For non-security bugs, please search GitHub issues to make sure someone else hasn't already reported the issue, and, if not, open an issue with the "bug" label containing the following information: -> 1. What OS and PowerShell version are you using? -> 2. What did you do? -> 3. What did you expect to see? -> 4. What did you see instead? +> 1. What release are you using? +> 1. What did you do? +> 1. What did you expect to see? +> 1. What did you see instead? ## How to suggest a feature or enhancement -If you wish to suggest a feature or enhancement, please enter a GitHub issue with the "enhancement" label detailing the suggestion. +If you wish to suggest a feature or enhancement, please search GitHub issues to make sure someone else hasn't already made the request, and, if not, enter an issue with the "enhancement" label. ## Code review process -As I'm just one person, and my scripting is a side-project to my normal sysadmin work, it may take me a while to review. +As I'm just one person, and my GitHub projects are a side-project to my normal job, it may take me a while to review. ## Questions If you have additional questions about contributing, please open a GitHub issue with the "question" tag. - -## Code Style - -I write all my PowerShell code according to the [PowerShell Best Practices and Style Guide](https://github.com/PoshCode/PowerShellPracticeAndStyle), so any contributions will be altered to match this style if they do not already follow it. \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..dbcdc0a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,17 @@ +# Security Policy + +## Supported Versions + +Only the most recent release is supported, no fixes will be backported. + +## Reporting a Vulnerability + + + +To report a security issue, please use the built-in GitHub vulnerability reporting on the Security tab. Provide a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue. This project follows a 90 day disclosure timeline.