Contributor Guide

What do I need to know to help?

If you are looking to help to with a code contribution, our project uses TypeScript, React, and Java. If you don’t feel ready to make a code contribution yet, no problem! You can also check out the documentation issues.

If you are interested in making a code contribution and would like to learn more about the technologies that we use, check out the list below:

How do I make a contribution?

Never made an open source contribution before? Wondering how contributions work in our project? Here’s a quick rundown:

  1. Find an issue that you are interested in addressing or a feature that you would like to add.

  2. Fork the repository associated with the issue to your local GitHub account.

  3. Clone your fork to your local machine using git clone git://<your username>/<repository name>.git.

  4. Add the Hawtio remote repository using git remote add upstream git://<repository name>.git.

  5. Create a new branch for your fix using git checkout -b <branch-name>.

  6. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.

  7. Commit your changes using a descriptive commit message that follows the commit message conventions.

  8. Push the changes to the remote repository using git push origin <branch-name>.

  9. Submit a pull request to the upstream repository.

  10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".

  11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It’s OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!

  12. Wait for the pull request to be reviewed by a maintainer.

  13. Make changes to the pull request if the reviewing maintainer recommends them.

  14. Celebrate your success after your pull request is merged!