From 9d134955c4f07de7b928e8c5ecbe727fc59c269d Mon Sep 17 00:00:00 2001 From: Steve Ebersole Date: Wed, 1 May 2013 14:00:49 -0500 Subject: [PATCH] HHH-8212 - Add CLA ref to CONTRIBUTING.md --- CONTRIBUTING.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a157cac46f..0ad0a0323a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 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 [GitHub account](https://github.com/signup/free) * [Fork](http://help.github.com/fork-a-repo) the Hibernate repository. As discussed in the linked page, this also includes: * [Set](https://help.github.com/articles/set-up-git) up your local git install * 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 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 +Create a [topic branch](http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches) 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` @@ -39,7 +41,7 @@ appreciated btw), please use rebasing rather than merging. Merging creates "merge commits" that really muck up the project timeline._ ## Submit -* Sign the [Contributor License Agreement](https://cla.jboss.org/index.seam). -* Push your changes to a topic branch in your fork of the repository. +* If you have not already, sign the [Contributor License Agreement](https://cla.jboss.org). +* Push your changes to the topic branch in your fork of the repository. * 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