Chapter 1. How to get help and contribute on Hibernate OGM

Hibernate OGM is a young project. The code, the direction and the documentation are all in flux and being built by the community. Come and help us shape it!

1.1. How to get help

First of all, make sure to read this reference documentation. This is the most comprehensive formal source of information. Of course, it is not perfect, feel free to come and ask for help, comment or propose improvements in our Hibernate OGM forum.

You can also

open bug reports in JIRA
propose improvements on the development mailing list
and join us on IRC to discuss developments and improvements (#hibernate-dev on freenode.net ; you need to be registered on freenode, the room does not accept "anonymous" persons).

1.2. How to contribute

Welcome!

There are many ways to contribute:

report bugs in JIRA
give feedback in the forum, IRC or the development mailing list
improve the documentation
fix bug or contribute new features

Hibernate OGM's code is available on GitHub at https://github.com/hibernate/hibernate-ogm.

1.2.1. how to build Hibernate OGM

Hibernate OGM uses Git and Maven 3, make sure to have both installed on your system.

Clone the git repository from GitHub:

#get the sources
git clone https://github.com/hibernate/hibernate-ogm
cd hibernate-ogm

Run maven

#build project
mvn clean install

Note

Note that Hibernate OGM uses artifacts from the Maven repository hosted by JBoss. Make sure to adjust your ~/.m2/settings.xml according to the descriptions available here.

To build the documentation, set the buildDocs property to true.

mvn clean install -DbuildDocs=true

If you just want to build the documentation, run it from the hibernate-ogm-documentation/manual subdirectory.

1.2.2. How to contribute code effectively

The best way to share code is to fork Hibernate OGM repository on GitHub, create a branch and open a pull request when you are ready. Make sure to rebase your pull request on the latest version in master before offering it.

Here are a couple of approaches the team follows:

We do small independent commits for each code change. In particular, we do not mix stylistic code changes (import, typo etc) and new feature in the same commit.
Commit messages follow the following convention: a short commit summary preceded by the JIRA issue number, an empty line, a longer description if needed.
```
OGM-123 Summary of commit operation

Optional details on the commit.
```
A pull request contains the feature, its unit tests, its documentation
All commits are proposed via pull requests and reviewed by another member of the team before being pushed to the reference repository.