CONTRIBUTING.md cleanup
This commit is contained in:
parent
acf765dad8
commit
932c2fe121
|
@ -1,5 +1,4 @@
|
|||
Guidelines for Contributing
|
||||
====
|
||||
# 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.
|
||||
|
@ -8,8 +7,8 @@ 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 signed a [Contributor License Agreement](https://cla.jboss.org) (CLA) for the Hibernate project
|
||||
* Make sure you have a [Hibernate JIRA account](https://hibernate.atlassian.net)
|
||||
* 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:
|
||||
|
@ -20,9 +19,9 @@ or [Eclipse](https://community.jboss.org/wiki/ContributingToHibernateUsingEclips
|
|||
|
||||
## Create the working (topic) branch
|
||||
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
|
||||
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`
|
||||
on the JIRA HHH-123 : `git checkout -b HHH-123 master`
|
||||
|
||||
|
||||
## Code
|
||||
|
@ -31,13 +30,13 @@ 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.
|
||||
* 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 commiting, if you want to pull in the latest upstream changes (highly
|
||||
_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._
|
||||
|
||||
|
@ -45,4 +44,4 @@ appreciated btw), please use rebasing rather than merging. Merging creates
|
|||
* 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
|
||||
* Update the JIRA issue, adding a comment including a link to the created pull request
|
||||
|
|
Loading…
Reference in New Issue