How to contribute¶
There are three common ways to contribute.
- Participate in discussions using GitHub issues.
- Contribute documentation by opening a GitHub Pull Request.
- Contribute code by opening a GitHub Pull Request
File a GitHub issue in the corresponding Project Mu repository.
General feedback and discussions¶
If the feedback is actionable, such as a feature request, file a feature request issue. Otherwise, start a new thread in the GitHub Discussions section of the corresponding Project Mu GitHub repository.
Bugs and feature requests¶
For non-security related bugs, please submit a new issue in the Project Mu GitHub repository that contains the code related to the issue.
The best way to get your bug fixed is to be as detailed as you can be about the problem. Providing a code snippet or sample driver that exposes the issue with steps to reproduce the problem is ideal.
Reporting security issues and bugs¶
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) email@example.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.
Contributions of Documentation and/or Code¶
If you don't know what a pull request is read this article: https://help.github.com/articles/about-pull-requests. Make sure the repository can build and all tests pass. Familiarize yourself with the project workflow and our coding conventions.
- Fork Repository in GitHub
- Make desired changes.
- Build it, test it, document it
- Submit a Pull Request back to the development branch you would like to target.
- You will be asked to digitally sign a CLA
- The server will run some builds and tests and report status
- Community and reviewers will provide feedback in the Pull Request
- Make changes / adjust based on feedback and discussion
- Keep your PR branch in-sync with the branch you are targeting and resolve any merge conflicts
- Once the the PR status is all passing it can be squashed and merged (just press the button in the PR). If the PR is ready the maintainers may complete it for you.
That is it. Thanks for contributing.
More details on:
Contributor License Agreement (CLA)¶
This project welcomes contributions and suggestions. Most (code and documentation) 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 https://cla.microsoft.com.
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 repos using our CLA.