Hibernate.orgCommunity Documentation
Hibernate OGM is a young project. Join and help us shape it!
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:
#hibernate-dev on freenode.net;
you need to be registered on freenode:
the room does not accept "anonymous" users).Welcome!
There are many ways to contribute:
Hibernate OGM’s code is available on GitHub at https://github.com/hibernate/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 -s settings-example.xml
Note that Hibernate OGM uses artifacts from the Maven repository hosted by JBoss.
Make sure to either use the -s settings-example.xml option
or adjust your ~/.m2/settings.xml
according to the descriptions available
on this jboss.org wiki page.
To skip building the documentation, set the skipDocs property to true:
mvn clean install -DskipDocs=true -s settings-example.xml
If you just want to build the documentation only,
run it from the hibernate-ogm-documentation/manual subdirectory.
The best way to share code is to fork the 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 of the master branch before offering it.
Here are a couple of approaches the team follows:
OGM-123 Summary of commit operation Optional details on the commit and a longer description can be added here.