Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 4.22 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 4.22 KB
Raw

Contributing to Azure/LinuxPatchExtension

First of all, thank you for considering contributing to the Azure LinuxPatchExtension repository!

Basics

If you would like to become an active contributor to this project, please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.

Table of Contents

Before starting

Making Changes

Before starting

Github basics

GitHub workflow

If you don't have experience with Git and Github, some of the terminology and process can be confusing. Here's a guide to understanding Github.

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.

Making Changes

Pull Requests

You can find all of the pull requests that have been opened in the Pull Request section of the repository.

To open your own pull request, click here. When creating a pull request, keep the following in mind:

  • Make sure you are pointing to the right remote and branch that your changes were made in
  • Choose the correct branch you want your pull request to be merged into
  • Always give a descriptive title for the pull request and include a brief overview in description

Pull Request Guidelines

Cleaning up Commits

If you are thinking about making a large change, break up the change into small, logical, testable chunks, and organize your pull requests accordingly.

Often when a pull request is created with a large number of files changed and/or a large number of lines of code added and/or removed, GitHub will have a difficult time opening up the changes on their site.

If you find yourself creating a pull request and are unable to see all the changes on GitHub, we recommend splitting the pull request into multiple pull requests that are able to be reviewed on GitHub.

If splitting up the pull request is not an option, we recommend creating individual commits for different parts of the pull request, which can be reviewed individually on GitHub.

For more information on cleaning up the commits in a pull request, such as how to rebase, squash, and cherry-pick, click here.

General guidelines

The following guidelines must be followed in EVERY pull request that is opened.

  • Title of the pull request is clear and informative
  • There are a small number of commits that each have an informative message
  • A description of the changes the pull request makes is included, and a reference to the issue being resolved, if the change address any
  • All files have the Microsoft copyright header

Testing Guidelines

The following guidelines must be followed in EVERY pull request that is opened.

  • Pull request includes test coverage for the included changes
  • All existing tests must continue to pass successfully on both Python 2.7+ and Python 3.x.
  • Code must have been tested on all supported distributions and versions of those distributions that have not reached end of life. The distribution test matrix is as follows:
Dist Version
Ubuntu Server 16.04-LTS, 18.04-LTS, 20.04-LTS
Red Hat Enterprise Linux 6 (x86/x64), 7 (x64), 8 (x64)
CentOS 6 (x86/x64), 7 (x64), 8 (x64)
SUSE Linux Enterprise Server 11 (x86/x64), 12 (x64), 15 (x64)

NOTE: Code is pending validation on Ubuntu Server 20.04-LTS, Red Hat Enterprise Linux 8 (x64), CentOS 8 (x64), SUSE Linux Enterprise Server 15 (x64), but will be supported when done.