Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 2.2 KB

File metadata and controls

32 lines (18 loc) · 2.2 KB

Contributing guidelines

Hello, thank you for your interest in contributing to our project.

Issues and Discussions

You are welcome to submit issues on bugs or feature requests. If you have questions, please ask them in GitHub Discussions.

Pull requests

If you want to contribute to the code of our project, you are welcome to open pull requests. However, it's always a good idea to open a related issue or talk with us in Discussions first.

Development

Please make sure you have a valid JDK installed. Some projects may require multiple JDKs of different versions. The JDK version we use can be found in the GitHub Actions workflow files.

We recommend developing with IntelliJ IDEA. In IntelliJ IDEA, select the correct Project SDK in Project Structure and it's recommended to set Gradle JVM to "Project SDK".

Run the publishToMavenLocal Gradle task to publish the libraries to your machine's Maven Local Repository so your projects can depend on the changes you have made, run check to ensure our limited number of tests pass.

Resolving *-dev-commit-* Huanshankeji artifacts from GitHub Packages (Gradle plugins from gradle-common, and any sibling dependency libraries configured in settings.gradle.kts) requires authentication. Put a personal access token with the read:packages scope in ~/.gradle/gradle.properties:

gpr.user=<GitHub username>
gpr.key=<PAT with read:packages>

Credentials are not needed for artifacts already present in Maven local (for example after ./gradlew publishToMavenLocal in upstream repos).

Further notice

We are currently a small team with limited effort. While we may not always implement your requested features, merge your pull requests, or do such things in time, you are always welcome to create your own fork and make any changes you like.