Welcome and thank you for your interest
in contributing to one-appconfig! Before contributing to this
project, please review this document for policies and procedures which
will ease the contribution and review process for everyone. If you have
questions, please contact Vassily Lyutsarev vassilyl@microsoft.com. This project adopted
Inner Source model.
Issues, bugs and proposed new features should be submitted to our backlog. The project uses Basic process which assumes your input is filed as an Issue. You may also tag the issue with a Bug tag which is optional. Please specify in detail the versions of python and msrc-appconfig package, and a detailed repro for the issue.
The project has adopted PEP 8 style for code. We use flake8 with default options to lint the code. Additionally, the mypy static type checker must run without issues on the code.
- Prepare your changes in a branch named
<your-alias>/<short-feature-description>. Alternativly, you may create your personal fork of the repository in Forks project. - All new code must come with corresponding pytest tests. Keep code coverage at 100%.
- Ensure CI build is successful and tests, including any added or updated tests, pass prior to submitting the pull request.
- Update any documentation, user and contributor, that is impacted by your changes.
- Do not change the version number in VERSION.txt.
- Do not merge your pull request, this is the responsibility of a core developer.
The project can be used for Microsoft internal purposes without any limitation. To use the package outside of Microsoft contact Vassily Lyutsarev vassilyl@microsoft.com.