Thanks for your interest in contributing to the Snowstorm Java Client.
You can find out a bit more about the project by reading the README file within this repository.
Issues can be used to:
- Report a defect
- Request a new feature or enhancement
- Ask a question
Please search through existing issues to ensure you are not creating a duplicate. Include as much information as you can in your issue, and if possible produce a link to a minimum reproducible example.
Please communicate with us (preferably through creation of an issue) before embarking on any significant work within a pull request. This will prevent situations where people are working at cross-purposes.
Your branch should be named issue/[GitHub issue #].
You will need the following software to build the solution:
- Maven 3^
- Java 17^
To run the project locally, run in the root dir:
mvn clean install
There's not too much code to speak of! This is essentially a code generation project.
Before making a contribution, please read the code of conduct.