Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-8212 - Add CLA ref to CONTRIBUTING.md

This commit is contained in:
Steve Ebersole 2013-05-01 14:00:49 -05:00
parent 07a6abfab9
commit 9d134955c4
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -8,18 +8,20 @@ contributing to a minimum, there are a few guidelines we ask that you mind.
If you are just getting started with Git, GitHub and/or contributing to Hibernate via If you are just getting started with Git, GitHub and/or contributing to Hibernate via
GitHub there are a few pre-requisite steps. GitHub there are a few pre-requisite steps.
* Make sure you have signed a [Contributor License Aggrement](https://cla.jboss.org) (CLA) for the Hibernate project
* Make sure you have a [Hibernate Jira account](https://hibernate.onjira.com) * Make sure you have a [Hibernate Jira account](https://hibernate.onjira.com)
* Make sure you have a [GitHub account](https://github.com/signup/free) * Make sure you have a [GitHub account](https://github.com/signup/free)
* [Fork](http://help.github.com/fork-a-repo) the Hibernate repository. As discussed in * [Fork](http://help.github.com/fork-a-repo) the Hibernate repository. As discussed in
the linked page, this also includes: the linked page, this also includes:
* [Set](https://help.github.com/articles/set-up-git) up your local git install * [Set](https://help.github.com/articles/set-up-git) up your local git install
* Clone your fork * Clone your fork
* See the wiki pages for setting up your IDE, whether you use [IntelliJ IDEA](https://community.jboss.org/wiki/ContributingToHibernateUsingIntelliJ)
or [Eclipse](https://community.jboss.org/wiki/ContributingToHibernateUsingEclipse).
## Create the working (topic) branch ## Create the working (topic) branch
Create a "topic" branch on which you will work. The convention is to name the branch Create a [topic branch](http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches) on which you
using the JIRA issue key. If there is not already a Jira issue covering the work you will work. The convention is to name the branch using the JIRA issue key. If there is not already a Jira issue
want to do, create one. Assuming you will be working from the master branch and working 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` on the Jira HHH-123 : `git checkout -b HHH-123 master`
@ -39,7 +41,7 @@ appreciated btw), please use rebasing rather than merging. Merging creates
"merge commits" that really muck up the project timeline._ "merge commits" that really muck up the project timeline._
## Submit ## Submit
* Sign the [Contributor License Agreement](https://cla.jboss.org/index.seam). * If you have not already, sign the [Contributor License Agreement](https://cla.jboss.org).
* Push your changes to a topic branch in your fork of the repository. * Push your changes to the topic branch in your fork of the repository.
* Initiate a [pull request](http://help.github.com/send-pull-requests/) * Initiate a [pull request](http://help.github.com/send-pull-requests/)
* Update the Jira issue, adding a comment inclusing a link to the created pull request * Update the Jira issue, adding a comment inclusing a link to the created pull request