Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
48 lines (38 sloc) 2.542 kB

Guidelines for Contributing

Contributions from the community are essential in keeping Hibernate (any Open Source project really) strong and successful. While we try to keep requirements for contributing to a minimum, there are a few guidelines we ask that you mind.

Getting Started

If you are just getting started with Git, GitHub and/or contributing to Hibernate via GitHub there are a few pre-requisite steps.

Create the working (topic) branch

Create a topic branch on which you will work. The convention is to name the branch using the JIRA issue key. If there is not already a JIRA issue covering the work you want to do, create one. Assuming you will be working from the master branch and working on the JIRA HHH-123 : git checkout -b HHH-123 master

Code

Do yo thing!

Commit

  • Make commits of logical units.
  • Be sure to use the JIRA issue key in the commit message. This is how JIRA will pick up the related commits and display them on the JIRA issue.
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken.
  • Make sure your source does not violate the checkstyles.

Prior to committing, if you want to pull in the latest upstream changes (highly appreciated btw), please use rebasing rather than merging. Merging creates "merge commits" that really muck up the project timeline.

Submit

  • If you have not already, sign the Contributor License Agreement.
  • Push your changes to the topic branch in your fork of the repository.
  • Initiate a pull request
  • Update the JIRA issue, adding a comment including a link to the created pull request
Jump to Line
Something went wrong with that request. Please try again.