azure-osconfig/CONTRIBUTING.md

Introduction

Azure Device OS Configuration (OSConfig) is a modular configuration stack for Linux Edge devices. OSConfig supports multi-authority device management over Azure and Azure Portal/CLI (via Azure PnP, IoT Hub, Azure Policy), GitOps, as well as local management (such as from Out Of Box Experience, OOBE). For more information on OSConfig see OSConfig North Star Architecture.

Code of conduct

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.

Contributing

We welcome contributions to OSConfig. The main way of contributing to and extending OSConfig is via developing new Management Modules. For more information see OSConfig Management Modules.

Pull requests with few exceptions must contain appropriate unit-tests. We cannot allow test coverage to go down. Pull requests containing code changes without accompanying unit tests may be rejected.

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.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 repositories using our CLA.

Submitting a PR

1. Create a GitHub account if you do not have one yet: Join GitHub.
2. Fork the public GitHub repo: https://github.com/Azure/azure-osconfig. Learn more about forking a repo.
3. Clone the forked repo. Optionally create a new branch to keep your changes isolated from the main branch. By forking and cloning the public GitHub repo, a copy of repo will be created in your GitHub account and a local copy will be locally created in your clone. Use this local copy to make modifications.
4. Commit the changes locally and push to your fork.
5. From your fork, create a PR that targets the main branch. Learn more about pull request.
6. The PR triggers a series of GitHub actions that will validate the new submitted changes.

The OSConfig Core team will respond to a PR that passes all checks in 3 business days.

Contact

You may contact the OSConfig Core team at osconfigcore@microsoft.com to ask questions about OSConfig, to report bugs, to suggest new features, or inquire about any other OSConfig related topic.