We welcome contributions of any kind to Thorntail from everyone.
We expect all contributors and users to follow our Code of Conduct when communicating through project channels. These include, but are not limited to: irc, issues, code, Google Group discussions.
Building Thorntail requires Java 8 or newer and Maven 3.3.3 or newer.
If you don't have one already, head to http://github.com/
Currently we have code styles defined for Intellij. Please follow the steps in the README on how to set them up.
We have defined a template for commit messages to help with clarity of any change that is made, thus making it easier for anyone not familiar with existing code to understand the impacts of a change.
Run the following:
curl http://thorntail.io/community/gitcommit-template.txt -o ~/.thorntail-gitmessage.txt
An alternative with wget
:
wget http://thorntail.io/community/gitcommit-template.txt -O ~/.thorntail-gitmessage.txt
Fork a Thorntail repository, such as https://github.com/thorntail/thorntail, or whichever repository contains the code/docs that you wish to change, into your GitHub account.
git clone git@github.com:[your username]/thorntail.git
cd thorntail
This makes it easy to pull down changes in the project over time
git remote add upstream git://github.com/thorntail/thorntail.git
Run the following:
git config commit.template ~/.thorntail-gitmessage.txt
This is the typical process you would follow to submit any changes to our GitHub repositories.
git pull --rebase upstream master
Note that --rebase will automatically move your local commits, if you have any, on top of the latest branch you pull from. If you don't have any commits it is safe to leave off, but for safety it doesn't hurt to use it each time just in case you have a commit you've forgotten about!
Either assign an existing JIRA to yourself, or create a new one at https://issues.jboss.org/browse/THORN.
git checkout -b my_cool_feature
If working on several changes it once, it may be beneficial to use the JIRA issue as the branch name.
Make whatever code changes, including new tests to verify your change, are necessary and ensure that the build and tests pass:
mvn clean install
If you're making non code changes, the above step is not required.
Add whichever files were changed into 'staging' before performing a commit:
git commit
During the commit process you will need to replace the various parts of the template that we added as part of the one time setup.
Here is some information to help:
Once all your commits for the issue have been made against your local topic branch, we need to rebase it against master in upstream to ensure that your commits are added on top of the current state of master. This will make it easier to incorporate your changes into the master branch, especially if there has been any significant time passed since you rebased at the beginning.
git pull --rebase upstream master
Now that you've sync'd your topic branch with upstream, it's time to push it to your GitHub repo.
git push origin my_cool_feature
Now your updates are in your GitHub repo, you will need to notify the project that you have code/docs for inclusion.
git checkout master
git pull upstream master
git push origin
Here are some tips on increasing the chance that your pull request is accepted:
mvn verify -Plicense