Contribute to Hibernate ORM
Contribute to Hibernate ORM
Thanks for your interest! Hibernate ORM is an open source project and community. Contributions, of any type or scope, drive the project forward!
Getting and building the code
You will need git to obtain the sources. ORM uses Gradle (entirely self-contained) to build, so no additional tools are necessary.
git clone git@github.com:hibernate/hibernate-orm.git
cd hibernate-orm
./gradlew clean build
./gradlew publishToMavenLocal (publishes to local maven repository)
./gradlew eclipse (generates Eclipse projects)
./gradlew idea (generates IntelliJ/IDEA projects)| You can find more information on how to build Hibernate ORM and its documentation on the README file at the root of the git repository. |
What to contribute
You can contribute anything (code, test cases, documentation)! If you do not have a specific itch to scratch, you can find the list of tasks suitable for new contributors. We also sincerely appreciate help generating test cases for existing tickets, identifying tickets that are no longer an issue, etc.
How to contribute
Share early and often!
In the open source way, it is better to share a prototype and get input from everyone early on. We love GitHub pull requests. This is our way to discuss features, review and share code. So fork our repository and send a pull request.
| Want to know more about Git and pull requests? You can start with this blog post. |
A good contribution has some or all of the following characteristics:
-
it respects the project code style - find templates for Eclipse and IntelliJ IDEA
-
a feature or bug fix has an associated set of appropriate tests
-
documentation is updated
-
the code compiles and the tests pass
./gradlew clean build
And last but not least, come discuss with us. We are hanging on the hibernate-dev mailing list and on #hibernate-dev on freenode.
