A coding agreement is a guideline validated by all the participants at the beginning of a project that defines what we expect in the code: how to name variables, functions, how exceptions should be managed, etc. This is not intended to replace official guidelines for a technology, but more to define how these guidelines apply to the current project. A coding agreement is meant to be more flexible than a style guide and can even go beyond it, for example, by defining which testing framework will be used, or providing templates for common but complex design patterns, such as dependency injection. Having the coding agreement read, understood, and validated by all (e.g., through a Pull Request review) will ensure that everyone will be on board with it.
This repo provides a baseline coding agreement for Python that can be extended for the needs of a specific project.
This project welcomes contributions and suggestions, for example coding agreements for languages other than Python or coding agreements for specific use cases.
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.
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.