Skip to content

Commit 36478f1

Browse files
authored
Merge pull request #131 from mgreenegit/main
repo requirements
2 parents 3b10366 + 649382a commit 36478f1

File tree

3 files changed

+92
-0
lines changed

3 files changed

+92
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Code of Conduct
2+
3+
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
4+
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [[email protected]][conduct-email] with any additional questions or comments.
5+
6+
[conduct-code]: https://opensource.microsoft.com/codeofconduct/
7+
[conduct-FAQ]: https://opensource.microsoft.com/codeofconduct/faq/
8+
[conduct-email]: mailto:[email protected]

CONTRIBUTING.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributing to DSC
2+
3+
We welcome and appreciate contributions from the community.
4+
There are many ways to become involved with DSC:
5+
including filing issues,
6+
joining in design conversations,
7+
and writing and improving documentation.
8+
Please read the rest of this document to ensure a smooth contribution process.
9+
10+
## Intro to Git and GitHub
11+
12+
* Make sure you have a [GitHub account](https://github.com/signup/free).
13+
* Learning GitHub:
14+
* GitHub Help: [Good Resources for Learning Git and GitHub][https://help.github.com/articles/good-resources-for-learning-git-and-github/]
15+
* [GitHub Flow Guide](https://guides.github.com/introduction/flow/):
16+
step-by-step instructions of GitHub Flow
17+
18+
## Contributing to Issues
19+
20+
* Check if the issue you are going to file already exists in our [GitHub issues](https://github.com/powershell/DSC/).
21+
* If you can't find your issue already,
22+
[open a new issue](https://github.com/PowerShell/DSC/issues/new/choose),
23+
making sure to follow the directions as best you can.
24+
25+
## Contributing to Documentation
26+
27+
### Contributing to documentation related to DSC
28+
29+
Please see the [PowerShell-Docs-DSC](https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/) repository for details.
30+
31+
### Contributing to documentation related to maintaining or contributing to the DSC project
32+
33+
* When writing Markdown documentation, use [semantic linefeeds](https://rhodesmill.org/brandon/2012/one-sentence-per-line/).
34+
In most cases, it means "one clause/idea per line".
35+
* Otherwise, these issues should be treated like any other issue in this repository.
36+
37+
#### Spellchecking documentation
38+
39+
Documentation is spellchecked. We use the
40+
[textlint](https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule) command-line tool,
41+
which can be run in interactive mode to correct typos.
42+
43+
To run the spellchecker, follow these steps:
44+
45+
* install [Node.js](https://nodejs.org/en/) (v10 or up)
46+
* install [textlint](https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule) by
47+
`npm install -g textlint textlint-rule-terminology`
48+
* run `textlint --rule terminology <changedFileName>`,
49+
adding `--fix` will accept all the recommendations.
50+
51+
If you need to add a term or disable checking part of a file see the [configuration sections of the rule](https://github.com/sapegin/textlint-rule-terminology).
52+
53+
#### Checking links in documentation
54+
55+
Documentation is link-checked. We make use of the
56+
`markdown-link-check` command-line tool,
57+
which can be run to see if any links are dead.
58+
59+
To run the link-checker, follow these steps:
60+
61+
* install [Node.js](https://nodejs.org/en/) (v10 or up)
62+
* install `markdown-link-check` by
63+
`npm install -g [email protected]`
64+
* run `find . \*.md -exec markdown-link-check {} \;`
65+
66+
## Code of Conduct Enforcement
67+
68+
Reports of abuse will be reviewed by the PS-Committee and if it has been determined that violations of the
69+
Code of Conduct has occurred, then a temporary ban may be imposed.
70+
The duration of the temporary ban will depend on the impact and/or severity of the infraction.
71+
This can vary from 1 day, a few days, a week, and up to 30 days.
72+
Repeat offenses may result in a permanent ban from the PowerShell org.

SECURITY.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Security Vulnerabilities
2+
3+
Security issues are treated very seriously and will, by default,
4+
takes precedence over other considerations including usability, performance,
5+
etc... Best effort will be used to mitigate side effects of a security
6+
change, but DSC must be secure by default.
7+
8+
## Reporting a security vulnerability
9+
10+
If you believe that there is a security vulnerability in DSC,
11+
it **must** be reported using [https://aka.ms/secure-at](https://aka.ms/secure-at) to allow for [Coordinated Vulnerability Disclosure](https://technet.microsoft.com/security/dn467923).
12+
**Only** file an issue, if [MSRC](https://www.microsoft.com/en-us/msrc/faqs-report-an-issue?rtc=1) has confirmed filing an issue is appropriate.

0 commit comments

Comments
 (0)