microsoft/gctoolkit
Publicmirrored from https://github.com/microsoft/gctoolkitAvailable
CONTRIBUTING.md
59lines · modecode
| 1 | # Contributing |
| 2 | |
| 3 | This project welcomes contributions and suggestions. Most contributions require you to |
| 4 | agree to a Contributor License Agreement (CLA) declaring that you have the right to, |
| 5 | and actually do, grant us the rights to use your contribution. For details, visit |
| 6 | [https://cla.microsoft.com](https://cla.microsoft.com). |
| 7 | |
| 8 | When you submit a pull request, a CLA-bot will automatically determine whether you need |
| 9 | to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the |
| 10 | instructions provided by the bot. You will only need to do this once across all repositories using our CLA. |
| 11 | |
| 12 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
| 13 | For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) |
| 14 | or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |
| 15 | |
| 16 | ## Prerequisite for Contributing on GCTooKit |
| 17 | |
| 18 | The gctoolkit build relies on test data which is archived in [GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry). This requires you to [authenticate to GitHub packages with a personal access token (PAT)](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-with-a-personal-access-token) to build and test. |
| 19 | |
| 20 | If your organization uses Single Sign-On (SSO), also follow the directions under [Authorizing a personal access token for use with SAML single sign-on](https://docs.github.com/en/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). |
| 21 | |
| 22 | You must also add `github` as a server in your `~/.m2/settings.xml` file. Replace `USERNAME` with your GitHub user name and `TOKEN` with your PAT. |
| 23 | |
| 24 | ```xml |
| 25 | <server> |
| 26 | <id>github</id> |
| 27 | <username>USERNAME</username> |
| 28 | <password>TOKEN</password> |
| 29 | </server> |
| 30 | ``` |
| 31 | |
| 32 | ## Build |
| 33 | |
| 34 | The build is vanilla Maven. |
| 35 | |
| 36 | * `mvn clean` - remove build artifacts |
| 37 | * `mvn compile` - compile the source code |
| 38 | |
| 39 | ### Additional build properties |
| 40 | |
| 41 | * `skipUnpack` - boolean. Defaults to `false`. This tells the build to skip unpacking the gctoolkit-testdata logs. |
| 42 | If the test data has already be extracted to the gclogs directory, setting this property to `true` can save |
| 43 | a minute or so of build time. |
| 44 | |
| 45 | ## Test |
| 46 | |
| 47 | Once above steps are configured you can execute test cases with following command. |
| 48 | |
| 49 | * `mvn test -Pcontributor` - run unit tests (this project uses JUnit 5) |
| 50 | |
| 51 | ### Contributor maven profile |
| 52 | |
| 53 | * `-Pcontributor` maven profile will enable downloading test data, checks that are required for the build, and running unit tests. |
| 54 | |
| 55 | ## Package |
| 56 | |
| 57 | The packaging is vanilla Maven. |
| 58 | |
| 59 | * `mvn package` - create the binaries. |
| 60 | |