First off, thank you for considering contributing to PatternFly Java. PatternFly Java is an open source project, and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into PatternFly Java itself.

We expect all contributors and users to follow our Code of Conduct when communicating through project channels. These include but are not limited to: chat, issues, code.

If you don't have one already, head to https://github.com/

Fork https://github.com/patternfly-java/patternfly-java into your GitHub account.

git clone git@github.com:[your username]/patternfly-java.git
cd patternfly-java

This makes it easy to pull down changes in the project over time

git remote add upstream git://github.com/patternfly-java/patternfly-java.git

This is the typical process you would follow to submit any changes to PatternFly Java.

git pull --rebase upstream main

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!

• GitHub Issues - https://github.com/patternfly-java/patternfly-java/issues

git checkout -b my_cool_feature

Make whatever code changes, including new tests to verify your change, are necessary and ensure that the build and tests pass. Make sure your code changes apply to the checkstyle rules:

mvn clean verify

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

Once all your commits for the issue have been made against your local topic branch, we need to rebase it against main in upstream to ensure that your commits are added on top of the current state of main. This will make it easier to incorporate your changes into the main branch, especially if there has been any significant time passed since you rebased at the beginning.

git pull --rebase upstream main

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.

• Send a pull request by clicking the pull request link while in your repository fork
• After review a maintainer will merge your pull request, update/resolve associated issues, and reply when complete
• Lastly, switch back to the main branch from your topic branch and pull the updates

git checkout main
git pull upstream main

• You may also choose to update your origin on GitHub as well

git push origin

Here are some tips on increasing the chance that your pull request is accepted:

• Write a good commit message
• Include tests that fail without your code and pass with it