2020-06-07 10:04:48 +03:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
This project welcomes contributions and suggestions. Most contributions require you to
|
|
|
|
|
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
|
|
|
|
|
and actually do, grant us the rights to use your contribution. For details, visit
|
2022-10-17 04:02:55 +03:00
|
|
|
<https://cla.microsoft.com>.
|
2020-06-07 10:04:48 +03:00
|
|
|
|
|
|
|
|
When you submit a pull request, a CLA-bot will automatically determine whether you need
|
|
|
|
|
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
|
|
|
|
|
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
|
|
|
|
|
|
|
|
|
## Code of Conduct
|
|
|
|
|
|
|
|
|
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
|
|
|
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
|
|
|
|
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
|
|
|
|
|
|
|
|
|
## How to contribute
|
|
|
|
|
|
|
|
|
|
- File or vote up issues
|
|
|
|
|
- Improve documentation
|
|
|
|
|
- Fix bugs or add features
|
|
|
|
|
|
|
|
|
|
### Intro to Git and GitHub
|
|
|
|
|
|
|
|
|
|
When contributing to documentation or code changes, you'll need to have a GitHub account and a basic understanding of Git.
|
|
|
|
|
Check out the links below to get started.
|
|
|
|
|
|
|
|
|
|
- Make sure you have a [GitHub account][github-signup].
|
|
|
|
|
- GitHub Help:
|
|
|
|
|
- [Git and GitHub learning resources][learn-git].
|
|
|
|
|
- [GitHub Flow Guide][github-flow].
|
|
|
|
|
- [Fork a repo][github-fork].
|
|
|
|
|
- [About Pull Requests][github-pr].
|
|
|
|
|
|
|
|
|
|
## Contributing to issues
|
|
|
|
|
|
2020-06-07 11:17:25 +03:00
|
|
|
- Check if the issue you are going to file already exists in our GitHub [issues](https://github.com/Microsoft/ps-rule/issues).
|
2020-06-07 10:04:48 +03:00
|
|
|
- If you do not see your problem captured, please file a new issue and follow the provided template.
|
|
|
|
|
- If the an open issue exists for the problem you are experiencing, vote up the issue or add a comment.
|
|
|
|
|
|
|
|
|
|
## Contributing to code
|
|
|
|
|
|
|
|
|
|
- Before writing a fix or feature enhancement, ensure that an issue is logged.
|
|
|
|
|
- Be prepared to discuss a feature and take feedback.
|
|
|
|
|
- Include unit tests and updates documentation to complement the change.
|
|
|
|
|
|
|
|
|
|
[learn-git]: https://help.github.com/en/articles/git-and-github-learning-resources
|
|
|
|
|
[github-flow]: https://guides.github.com/introduction/flow/
|
|
|
|
|
[github-signup]: https://github.com/signup/free
|
|
|
|
|
[github-fork]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo
|
|
|
|
|
[github-pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
|
