-
Notifications
You must be signed in to change notification settings - Fork 4
CONTRIBUTING
First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
- Star the project
- Tweet about it
- Refer this project in your project's readme
- Mention the project at local meetups and tell your friends/colleagues
If you want to ask a question, we assume that you have read the available Documentation.
Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue or in the project discussion. It is also advisable to search the internet for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue.
- Provide as much context as you can about what you're running into.
- Provide any other information that seems relevant.
We will then take care of the issue as soon as possible.
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already an issue report existing for your bug or error in the issues tracker.
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to billybolton16@gmail.com.
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
- Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
Once it's filed:
- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team
will ask you for those steps and mark the issue as
needs-repro. Bugs with theneeds-reprotag will not be addressed until they are reproduced. - If the team is able to reproduce the issue, it will be marked
needs-fix, as well as possibly other tags (such ascritical), and the issue will be left to be implemented by someone.
This section guides you through submitting an enhancement suggestion for springharvest, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
- Make sure that you are using the latest version.
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
Enhancement suggestions are tracked as GitHub issues.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
- You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most springharvest users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
You can start by reading this section of the documentation
This project strives to ensure all dependencies use the most current up-to-date LTS versions.
| Name | Version | Documentation | Instructions |
|---|---|---|---|
| Docker Desktop | 4.25.2 (129061) | https://docs.docker.com | This project uses Liquibase to track the database changelogs used in the examples submodules, while populating test data for automated and manual testing. As such, please ensure Docker is running in the background by opening Docker Desktop. You may notice Liquibase fails at start up, otherwise. |
| Java | See here | https://docs.oracle.com/en/java/javase/21/ | Ensure Java with the specified version is sourced by configuring your preferred IDE and/or manually in your computer settings. |
JetBrains IntelliJ
Please follow the documentation for Configuring an annotation profile in IntelliJ, ensuring that theEnable annotation processing setting is enabled.
Eclipse
Please follow the documentation for Eclipse JDT-APT Project here.VSCode
Please follow the documentation for Annotation processing support in Gradle for VSCode.The root directory has a file called secrets-TEMPLATE.gradle that stores they key-value that Gradle will use to source private dependencies and running CI/CD processes like Sonar Cloud scanning.
To populate these secrets:
-
Duplicate the
secrets-TEMPLATE.gradlefile and rename it tosecrets.gradle. (Thesecrets.gradlefile is included in.gitignore.) -
Replace all respective values. You may reference secret configuration for the respective services below.
Github
Complete the steps for "Creating a personal access token (classic)", ensuring that it has read packages permission selected.
| Key | Example Value | Description |
|---|---|---|
| GPR_USER | "Jane Doe" |
Github Username |
| GPR_KEY | "ghp_xXxxxXXXxXxxxxXxXXXXxxxxXxXxXXXxXxXX" |
Github Access Token |
Sonar
Forking this project will not fork other CI/CD processes that use third-party tools & services, like Sonar Cloud. Contributors are free to use whichever tooling they'd like in their forked repository. As such, explaining steps to replicate the GitHub Actions in this repository to work in your own forked repository is out-of-scope for this document. If you would like to use Sonar Cloud locally, however, please reference the Sonar Cloud setup documentation here and populate the secrets below in your secrets.gradle file.
| Key | Example Value | Description |
|---|---|---|
| SONAR_ORGANIZATION | "MyOrganization" |
Your GitHub organization or username. |
| SONAR_PROJECT_KEY | "MyOrganization_springharvest" |
Your organization's Sonar Cloud project name. |
| SONAR_TOKEN | "ghp_xXxxxXXXxXxxxxXxXXXXxxxxXxXxXXXxXxXX" |
Your secure Sonar Cloud token that is associated with your personal or organization configured Sonar project. |
| Name | Documentation | About |
|---|---|---|
| DBeaver Community | https://dbeaver.io/ | DBeaver Community is a free cross-platform database tool for developers, database administrators, analysts, and everyone working with data. It supports all popular SQL databases like MySQL, MariaDB, PostgreSQL, SQLite, Apache Family, and more. |
| Docker | https://www.docker.com/community/open-source/ | Docker collaborates with the open source ecosystem through an array of projects that continue to fuel the containerization movement, the Docker platform and other Docker products. |
| Postman | https://www.postman.com/product/what-is-postman/ | Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster. |
| SDKMAN | https://sdkman.io/ | Meet SDKMAN! – your reliable companion for effortlessly managing multiple Software Development Kits on Unix systems. Imagine having different versions of SDKs and needing an stress-free way to switch between them. SDKMAN! steps in with its easy-to-use Command Line Interface (CLI) and API. Formerly known as GVM, the Groovy enVironment Manager, SDKMAN! draws inspiration from familiar tools like apt, pip, RVM, and rbenv and even Git. Think of it as your helpful toolkit friend, ready to streamline SDK management for you. |