NOTE: This CONTRIBUTING.md is for software contributions. You do not need to follow the Developer's Certificate of Origin (DCO) process for commenting on the repository documentation, such as CONTRIBUTING.md, INTENT.md, etc. or for submitting issues.
Thanks for thinking about using or contributing to this software ("Project") and its documentation!
The project maintainer for this Project will only accept contributions using the Developer's Certificate of Origin 1.1 located at developercertificate.org ("DCO"). The DCO is a legally binding statement asserting that you are the creator of your contribution, or that you otherwise have the authority to distribute the contribution, and that you are intentionally making the contribution available under the license associated with the Project ("License").
Before submitting contributing code to this repository for the first time, you'll need to sign a Developer Certificate of Origin (DCO) (see below). To agree to the DCO, add your name and email address to the CONTRIBUTORS.md file. At a high level, adding your information to this file tells us that you have the right to submit the work you're contributing and indicates that you consent to our treating the contribution in a way consistent with the license associated with this software (as described in LICENSE.md) and its documentation ("Project").
Pseudonymous or anonymous contributions are permissible, but you must be reachable at the email address provided in the Signed-off-by line.
U.S. Federal law prevents the government from accepting gratuitous services unless certain conditions are met. By submitting a pull request, you acknowledge that your services are offered without expectation of payment and that you expressly waive any future pay claims against the U.S. Federal government related to your contribution.
If you are a U.S. Federal government employee and use a *.mil or *.gov email address, we interpret your Signed-off-by to mean that the contribution was created in whole or in part by you and that your contribution is not subject to copyright protections.
The full text of the DCO is included below and is available online at developercertificate.org:
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.The Vortex repository includes the Vortex API along with several user interface utilities. Vortex is written in Java and uses the Gradle build tool.
You will need JDK 8. The version used for building releases is OpenJDK 8, from Amazon Corretto. The AdoptOpenJDK does not include the JavaFX library; Attempts to build with AdoptOpenJDK will fail to compile.
This repository includes a Gradle Wrapper; No Gradle installation is required. The JAVA_HOME environment variable should be set to a project appropriate JDK.
Clone the repository locally and start making changes. The project is organized as a Gradle multi-project build. Source code is in src folders.
Feel free to submit an issue on our GitHub repository for anything you find that needs attention.
When submitting a bug report on the website, please be sure to include accurate and thorough information about the problem you're observing. Be sure to include:
- Steps to reproduce the problem,
- Area of the program where you found the bug,
- What you expected to happen,
- What actually happend (or didn't happen), and
- Technical details including your Operating System name and version.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
When making your changes, it is highly encouraged that you use a branch in Git, then submit a pull request (PR) on GitHub.
After review, your PR will either be commented on with a request for more information or changes, or it will be merged into the develop branch. The develop branch will periodically be merged with the master branch for release.
Before submitting your pull request, you should run the build process locally first to ensure things are working as expected. Build the project using the following command:
gradlew buildYou should also run the tests against your local build. Run tests using the following command:
gradlew testTo run a Vortex utility use the gradle run command:
gradlew importer:run