Get involved!

There are a few steps that you must follow before being able to push changes to our project:

1. Have the necessary knowledge

Knowledge in the Java programming language and tools used:
• It is necessary that the developer is willing to acquire experience in Java 9 or higher and JavaFX 11 since it is the language and framework that is used in the project.
• Use git
• Knowledge in Gradle
• IntelliJ IDEA (recommended, but not necessary)
• Knowledge in MySQL database
• Knowledge in the Springboot framework

2. Get the code and compile/run the software

To do the development you need a local copy of the source code. All the code remains in git.
To run the program you need an instance of MySQL running, you do not have to worry about scripts because thanks to the framework this generates the entire database automatically.
To connect to the instance, you must edit hibernate.properties in persistence/src/main/resources.
Once this is done, execute the task of run of gradle from the root of the project, gradle run, and that's it!

3. Find your first bug to solve

It is recommended to start with some simple bugs, such as, bugs related to usability. Once a Ticket is found in which to work, the Ticket must be assigned to oneself to know that the error is being solved. In case of any problem you can communicate with the development team and other contributors with our mailing list or the discussion forum.

4. Save the changes made

You have to take a few things into account:
• Never make changes to your master copy, create a branch instead.
• Keep a separate branch for each bug and do not delete the branch until the patch is merged.
• Code Style must be followed (such as variable name schemes, etc.).
• If you create new files, use our license header.
• Update master before starting a new error.
• Do not send patches that depend on each other, unless it is indicated to do so. Doing so will make your patch unable to merge.
• The review takes time and we are all volunteers, so wait a couple of days.

5. Submit the patch

Once you have the patch ready, you must open a request to do merge in master, in the description of the request you must include the Ticket to which that patch belongs.

Happy coding!