GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

microsoft/gctoolkit

Public

mirrored from https://github.com/microsoft/gctoolkitAvailable

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
enable-agentic-workflows

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

CONTRIBUTING.md

47lines · modeblame

RawDownload
Update dependencies and ability to pass in compile version (#314)7aecfbd
c154caedMartijn Verburg4 years ago1# Contributing
2
3ce8e8bbKirk Pepperdine4 years ago3This project welcomes contributions and suggestions. Most contributions require you to
4agree to a Contributor License Agreement (CLA) declaring that you have the right to,
5and actually do, grant us the rights to use your contribution. For details, visit
c154caedMartijn Verburg4 years ago6[https://cla.microsoft.com](https://cla.microsoft.com).
3ce8e8bbKirk Pepperdine4 years ago7
8When you submit a pull request, a CLA-bot will automatically determine whether you need
9to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
10instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
11
12This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
13For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
14or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
68fce743Anant Kurapati4 years ago15
53e02449Kirk Pepperdine4 years ago16## Submit an Issue
68fce743Anant Kurapati4 years ago17
a8bdf17bBruno Borges4 years ago18if 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.
7aecfbd1Martijn Verburg2 years ago19
6790f05bMartijn Verburg4 years ago20## Build
68fce743Anant Kurapati4 years ago21
7aecfbd1Martijn Verburg2 years ago22The 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.
68fce743Anant Kurapati4 years ago23
7aecfbd1Martijn Verburg2 years ago24* `./mvnw clean` - remove build artifacts
25* `./mvnw compile` - compile the source code.
68fce743Anant Kurapati4 years ago26
6790f05bMartijn Verburg4 years ago27## Test
28
a8bdf17bBruno Borges4 years ago29You can execute test cases with following command.
6790f05bMartijn Verburg4 years ago30
7aecfbd1Martijn Verburg2 years ago31* `./mvnw test` - run unit tests (this project uses JUnit 5)
6790f05bMartijn Verburg4 years ago32
33## Package
34
35The packaging is vanilla Maven.
36
7aecfbd1Martijn Verburg2 years ago37* `./mvnw package` - create the binaries.
38
39## Site
40
41The packaging is vanilla Maven.
42
43* `./mvnw site` - create the site with reports on source code analysis etc.
c73e6963Martijn Verburg4 years ago44
45## Deploy / Publish
46
47This 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.