|
1 | | -# Contributing |
| 1 | +# Contributing to Microsoft Entra PowerShell |
2 | 2 |
|
3 | | -When contributing to this repository, first open an issue describing the update you wish to make and read over our guidelines. |
| 3 | +This repository contains PowerShell cmdlets for developers and administrators to develop, deploy, |
| 4 | +administer, and manage Microsoft Entra product family resources. |
4 | 5 |
|
5 | | -There are a few different recommended paths to get contributions into the released version. |
| 6 | +## Basics |
| 7 | + |
| 8 | +If you would like to become a contributor to this project (or any other open source Microsoft |
| 9 | +project), see how to [Get Involved](https://opensource.microsoft.com/collaborate/). |
| 10 | + |
| 11 | +## Before Starting |
| 12 | + |
| 13 | +### Onboarding |
| 14 | + |
| 15 | +All users must sign the |
| 16 | +[Microsoft Contributor License Agreement (CLA)](https://cla.opensource.microsoft.com/) before making |
| 17 | +any code contributions. For Microsoft employees, make sure that your GitHub account is part of the |
| 18 | +Microsoft Graph organization. [Use this page](https://repos.opensource.microsoft.com/) to link your account. |
| 19 | + |
| 20 | +### Code of Conduct |
| 21 | + |
| 22 | +This project adopts the |
| 23 | +[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more |
| 24 | +information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or |
| 25 | +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any more questions or |
| 26 | +comments. |
| 27 | + |
| 28 | +### GitHub Basics |
| 29 | + |
| 30 | +#### GitHub Workflow |
| 31 | + |
| 32 | +The following guides provide basic knowledge for understanding Git command usage and the workflow of |
| 33 | +GitHub. |
| 34 | + |
| 35 | +- [Git Cheat Sheet](https://education.github.com/git-cheat-sheet-education.pdf) |
| 36 | +- [GitHub Flow](https://guides.github.com/introduction/flow/) |
| 37 | + |
| 38 | +#### Forking the microsoftgraph/entra-powershell repository |
| 39 | + |
| 40 | +Unless you're working with multiple contributors on the same file, we ask that you fork the |
| 41 | +repository and submit your pull request from there. The following guide explains how to fork a |
| 42 | +GitHub repo. |
| 43 | + |
| 44 | +- [Contributing to GitHub projects](https://guides.github.com/activities/forking/). |
6 | 45 |
|
7 | 46 | ## Filing Issues |
8 | 47 |
|
9 | | -The best way to get started with a contribution is to start a dialog with us. Sometimes, features are under development or out of scope for this module, and it's best to check before starting work on contribution, especially for large work items. |
| 48 | +You can find all of the issues filed for Microsoft Entra PowerShell in the |
| 49 | +[Issues](https://aka.ms/entra/ps/issues) section of this repository. |
| 50 | + |
| 51 | +To file an issue, select one of the |
| 52 | +[templates](https://github.com/microsoftgraph/entra-powershell/issues/new/choose). The template ensures that all of |
| 53 | +the necessary information is provided. The following are a few of the templates we provide: |
| 54 | + |
| 55 | +- [_Entra PowerShell module bug report_](https://github.com/microsoftgraph/entra-powershell/issues/new?assignees=&labels=ToTriage&projects=&template=entra-powershell-bug-report.md) |
| 56 | +- [_Feature request_](https://github.com/microsoftgraph/entra-powershell/issues/new?assignees=&labels=ToTriage&projects=&template=feature_request.md&title=%5BFeature%5D%3A+) |
| 57 | + |
| 58 | +You can find the code complete and release dates of the upcoming Entra PowerShell releases in the |
| 59 | +[Milestones](https://github.com/microsoftgraph/entra-powershell/milestones) section of the _Issues_ page. |
| 60 | +Each milestone displays the issues that are being worked on for the corresponding release. |
| 61 | + |
| 62 | +## Submitting Changes |
| 63 | + |
| 64 | +### Pull Requests |
| 65 | + |
| 66 | +You can find all of the pull requests that opened in the |
| 67 | +[Pull Requests](https://github.com/microsoftgraph/entra-powershell/pulls) section of this repository. |
| 68 | + |
| 69 | +When creating a pull request, keep the following in mind: |
| 70 | + |
| 71 | +- Verify you're pointing to the fork and branch that your changes were made in. |
| 72 | +- Choose the correct branch you want your pull request to be merged into. |
| 73 | + - The **main** branch is for active development; changes in this branch will be in the next Entra |
| 74 | + PowerShell release. |
| 75 | +- The pull request template that is provided **must be filled out**. Don't delete or ignore it when |
| 76 | + the pull request is created. |
| 77 | + - **_IMPORTANT:_** Deleting or ignoring the pull request template delays the PR review process. |
| 78 | +- The SLA for reviewing pull requests is **three business days**. |
| 79 | + |
| 80 | +### Pull Request Guidelines |
| 81 | + |
| 82 | +A pull request template will automatically be included as a part of your PR. Fill out the |
| 83 | +checklist as specified. Pull requests **will not be reviewed** unless they include a properly |
| 84 | +completed checklist. |
| 85 | + |
| 86 | +#### Testing guidelines |
10 | 87 |
|
11 | | -## Improving Commands |
| 88 | +The following guidelines must be followed in **every** pull request that is opened. |
12 | 89 |
|
13 | | -This module provides a customization logic that helps us to manually improve the autogenerated code, adding missing Commands, missing parameters on Commands, and missing output values. Check the customization guidelines. |
| 90 | +- Changes made have corresponding test coverage. |
| 91 | +- Tests shouldn't include any hardcoded values, such as DisplayName, resource ID, etc. |
| 92 | +- No existing tests should be skipped. |
0 commit comments