microsoft/gctoolkit
Publicmirrored from https://github.com/microsoft/gctoolkitAvailable
CONTRIBUTING.md
47lines · 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 | ## Submit an Issue |
| 17 | |
| 18 | if you wish to contribute to GCToolKit we would kindly ask that you submit an issue to the issue tracker. Doing so will help with the management of the project. |
| 19 | |
| 20 | ## Build |
| 21 | |
| 22 | The build requires JDK 11 and uses the Maven wrapper (`mvnw`) to help ensure reproducible builds and so we don't force you to change your system Maven install. If you prefer to build with your local Maven installation, make sure the version matches the one in the project's [.mvn/wrapper/maven-wrapper.properties](https://github.com/microsoft/gctoolkit/blob/main/.mvn/wrapper/maven-wrapper.properties) file. You can also use JDK 17 or 21 by passing in `-Dmaven.compiler.release=<17|21>` as an extra property to any of the `./mvnw` commands below. |
| 23 | |
| 24 | * `./mvnw clean` - remove build artifacts |
| 25 | * `./mvnw compile` - compile the source code. |
| 26 | |
| 27 | ## Test |
| 28 | |
| 29 | You can execute test cases with following command. |
| 30 | |
| 31 | * `./mvnw test` - run unit tests (this project uses JUnit 5) |
| 32 | |
| 33 | ## Package |
| 34 | |
| 35 | The packaging is vanilla Maven. |
| 36 | |
| 37 | * `./mvnw package` - create the binaries. |
| 38 | |
| 39 | ## Site |
| 40 | |
| 41 | The packaging is vanilla Maven. |
| 42 | |
| 43 | * `./mvnw site` - create the site with reports on source code analysis etc. |
| 44 | |
| 45 | ## Deploy / Publish |
| 46 | |
| 47 | This is a task performed by the core project maintainers, if you think they're behind or would like to get a release out please raise a GitHub issue. |
| 48 | |