Skip to content

Commit 3ba680d

Browse files
committed
Improve doc
1 parent d983769 commit 3ba680d

4 files changed

Lines changed: 29 additions & 18 deletions

File tree

‎.github/dependabot.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ updates:
55
directory: "/"
66
schedule:
77
interval: "monthly"
8+
open-pull-requests-limit: 100

‎CODE_OF_CONDUCT.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Contributor Covenant Code of Conduct
32

43
## Our Pledge
@@ -60,7 +59,8 @@ representative at an online or offline event.
6059
## Enforcement
6160

6261
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63-
reported to the community leaders responsible for enforcement via GitHub Issues.
62+
reported to the community leaders responsible for enforcement via the built-in
63+
GitHub vulnerability reporting on the Security tab.
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
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
130130
[Mozilla CoC]: https://github.com/mozilla/diversity
131131
[FAQ]: https://www.contributor-covenant.org/faq
132132
[translations]: https://www.contributor-covenant.org/translations
133-

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,38 +14,32 @@ If I accept your contribution, I'll add you to the Authors section in the README
1414

1515
## How to Contribute
1616

17-
If you would like to make a simple contribution (a few lines or less), please put it in an Issue with the "contribution" label.
18-
19-
For larger contributions, please fork this project, make the changes/additions, and then issue a Pull Request.
17+
For contributions, please fork this project, make the changes/additions, and then issue a Pull Request.
2018
Never done a pull request before? There's an easy tutorial [here](http://makeapullrequest.com/).
2119

2220
## How to report a bug
2321

2422
### Vulnerabilities
2523

26-
If you find a security vulnerability, please do NOT open an Issue. Instead, email security@REPLACE-THIS-WITH-MY-GITHUB-USERNAME.com
24+
If you find a security vulnerability, please do NOT open an Issue. Instead, see [SECURITY.md](SECURITY.md)
2725

2826
### Non-Security Bugs
2927

30-
For non-security bugs, please open a GitHub issue with the "bug" label containing the following information:
28+
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:
3129

32-
> 1. What OS and PowerShell version are you using?
33-
> 2. What did you do?
34-
> 3. What did you expect to see?
35-
> 4. What did you see instead?
30+
> 1. What release are you using?
31+
> 1. What did you do?
32+
> 1. What did you expect to see?
33+
> 1. What did you see instead?
3634
3735
## How to suggest a feature or enhancement
3836

39-
If you wish to suggest a feature or enhancement, please enter a GitHub issue with the "enhancement" label detailing the suggestion.
37+
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.
4038

4139
## Code review process
4240

43-
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.
41+
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.
4442

4543
## Questions
4644

4745
If you have additional questions about contributing, please open a GitHub issue with the "question" tag.
48-
49-
## Code Style
50-
51-
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.

‎SECURITY.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Only the most recent release is supported, no fixes will be backported.
6+
7+
## Reporting a Vulnerability
8+
9+
<!--
10+
Use this section to tell people how to report a vulnerability.
11+
12+
Tell them where to go, how often they can expect to get an update on a
13+
reported vulnerability, what to expect if the vulnerability is accepted or
14+
declined, etc.
15+
-->
16+
17+
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.

0 commit comments

Comments
 (0)