|
1 | | -# Contribution Guide |
| 1 | +# Contribution guide |
2 | 2 |
|
3 | | -* Fork the repository |
4 | | -* Your working directory is `.\Azure-MG-Sub-Governance-Reporting` |
5 | | - * In the folder `.\pwsh\dev` find the function you intend to work on, apply your changes |
6 | | - * Edit the file `.\pwsh\dev\devAzGovVizParallel.ps1` |
7 | | - * In the param block update the parameter variable `$ProductVersion` accordingly |
8 | | - * Execute `.\pwsh\dev\buildAzGovVizParallel.ps1` - This step will rebuilt the main `.\pwsh\AzGovVizParallel.ps1` file (incorporating all changes you did in the `.\pwsh\dev` directory) |
9 | | - * Edit the file `.\README.md` |
10 | | - * Update the region `Release history`, replace the changes from the previous release with your changes |
11 | | - * Edit the file `.\history.md` |
12 | | - * Copy over text for the change description you just did for the `.\README.md` |
13 | | - * Execute the newly created AzGovViz version to test if it completes successfully |
14 | | - `.\pwsh\AzGovVizParallel.ps1 -ShowRunIdentifier` |
15 | | - From the very last line of the output take a copy of the __run identifier__ and provide that with the pull request |
16 | | -* Commit your changes |
17 | | -* Create a pull request |
18 | | - * Provide the __run identifier__ in the pull request as a proof of successful test |
| 3 | +1. Fork the repository. |
| 4 | +1. Change you working directory to `.\Azure-MG-Sub-Governance-Reporting`. |
| 5 | +1. In the folder `.\pwsh\dev` find the function you intend to work on and apply your changes. |
| 6 | +1. Edit the file `.\pwsh\dev\devAzGovVizParallel.ps1`. |
| 7 | + - In the param block update the parameter variable `$ProductVersion` accordingly. |
| 8 | + - Note: Do not change anything else in this file if you did not introduce new functions! |
| 9 | +1. Execute `.\pwsh\dev\buildAzGovVizParallel.ps1` - This step will rebuilt the main `.\pwsh\AzGovVizParallel.ps1` file, incorporating all changes you did in the `.\pwsh\dev` directory. |
| 10 | +1. Edit the file `.\README.md`. |
| 11 | + - Update the region `Release history`, replace the changes from the previous release with your changes. |
| 12 | +1. Edit the file `.\history.md`. |
| 13 | + - Copy over text for the change description you just did for the `.\README.md`. |
| 14 | +1. Execute the newly created AzGovViz version to test if it completes successfully by running `.\pwsh\AzGovVizParallel.ps1 -ShowRunIdentifier`. |
| 15 | + - From the very last line of the output copy the __run identifier__, you'll need that when you open your pull request. |
| 16 | +1. Commit your changes. |
| 17 | +1. Create a pull request |
| 18 | + - Provide the __run identifier__ in the pull request as a proof of successful test |
0 commit comments