Welcome to the WildFly Glow project! We welcome contributions from the community. This guide will walk you through the steps for getting started on our project.
To contribute, you will first need to fork the glow repository.
This can be done by looking in the top-right corner of the repository page and clicking "Fork".
The next step is to clone your newly forked repository onto your local workspace.
This can be done by going to your newly forked repository, which should be at https://github.com/USERNAME/wildfly-glow.
Then, there will be a green button that says "Code". Click on that and copy the URL.
Then, in your terminal, paste the following command:
git clone [URL]Be sure to replace [URL] with the URL that you copied.
Now you have the repository on your computer!
This project uses Github Issues to manage issues. All issues can be found here.
You will need:
- JDK 11
- Git
- Maven 3.3.9 or later
- An IDE (e.g., IntelliJ IDEA, Eclipse, etc.)
First cd to the directory where you cloned the project (eg: cd wildfly-glow)
Add a remote ref to upstream, for pulling future updates. For example:
git remote add upstream https://github.com/wildfly/wildfly-glow
To build wildfly-glow run:
mvn clean installWhen submitting a PR, please keep the following guidelines in mind:
-
In general, it's good practice to squash all of your commits into a single commit. For larger changes, it's ok to have multiple meaningful commits. If you need help with squashing your commits, feel free to ask us how to do this on your pull request. We're more than happy to help!
-
Please include the Issue number and title you worked on in the title of your pull request and in your commit message.
-
Please include the link to the Issue you worked on in the description of the pull request.