AKS-Landing-Zone-Accelerator/CONTRIBUTING.md

2.4 KiB

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 https://cla.opensource.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., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Commit Standards

For commits, use the following prefixes depending on which is most applicable to the changes:

Prefix Purpose
fix: Update to code base or bug
feat: New feature added to code base
chore: Basic task to update formatting or versions, etc.
docs: New documentations or updates to documentation in Markdown file(s)
ci: New workflow or updates to workflow(s)
test: New tests or updates to testing framework(s)

Branch Naming Standards

For branches, use the following prefixes depending on which is most applicable to the work being done:

Prefix Purpose
fix/ Any task related to a bug or minor fix
feat/ Any task related to a new feature of the codebase
chore/ Any basic task that involves minor updates that are not bugs
docs/ Any task pertaining to documentation
ci/ Any task pertaining to workflow changes
test/ Any task pertaining to testing updates

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.