1
- Guidelines for Contributing
2
- ====
1
+ # Guidelines for Contributing
3
2
Contributions from the community are essential in keeping Hibernate (any Open Source
4
3
project really) strong and successful. While we try to keep requirements for
5
4
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.
8
7
If you are just getting started with Git, GitHub and/or contributing to Hibernate via
9
8
GitHub there are a few pre-requisite steps.
10
9
11
- * Make sure you have signed a [ Contributor License Aggrement ] ( https://cla.jboss.org ) (CLA) for the Hibernate project
12
- * Make sure you have a [ Hibernate Jira account] ( https://hibernate.onjira.com )
10
+ * Make sure you have signed a [ Contributor License Agreement ] ( https://cla.jboss.org ) (CLA) for the Hibernate project
11
+ * Make sure you have a [ Hibernate JIRA account] ( https://hibernate.atlassian.net )
13
12
* Make sure you have a [ GitHub account] ( https://github.com/signup/free )
14
13
* [ Fork] ( http://help.github.com/fork-a-repo ) the Hibernate repository. As discussed in
15
14
the linked page, this also includes:
@@ -20,9 +19,9 @@ or [Eclipse](https://community.jboss.org/wiki/ContributingToHibernateUsingEclips
20
19
21
20
## Create the working (topic) branch
22
21
Create a [ topic branch] ( http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches ) on which you
23
- will work. The convention is to name the branch using the JIRA issue key. If there is not already a Jira issue
22
+ will work. The convention is to name the branch using the JIRA issue key. If there is not already a JIRA issue
24
23
covering the work you want to do, create one. Assuming you will be working from the master branch and working
25
- on the Jira HHH-123 : ` git checkout -b HHH-123 master `
24
+ on the JIRA HHH-123 : ` git checkout -b HHH-123 master `
26
25
27
26
28
27
## Code
@@ -31,18 +30,18 @@ Do yo thing!
31
30
## Commit
32
31
33
32
* Make commits of logical units.
34
- * Be sure to use the JIRA issue key in the commit message. This is how Jira will pick
35
- up the related commits and display them on the Jira issue.
33
+ * Be sure to use the JIRA issue key in the commit message. This is how JIRA will pick
34
+ up the related commits and display them on the JIRA issue.
36
35
* Make sure you have added the necessary tests for your changes.
37
36
* Run _ all_ the tests to assure nothing else was accidentally broken.
38
37
* Make sure your source does not violate the checkstyles.
39
38
40
- _ Prior to commiting , if you want to pull in the latest upstream changes (highly
39
+ _ Prior to committing , if you want to pull in the latest upstream changes (highly
41
40
appreciated btw), please use rebasing rather than merging. Merging creates
42
41
"merge commits" that really muck up the project timeline._
43
42
44
43
## Submit
45
44
* If you have not already, sign the [ Contributor License Agreement] ( https://cla.jboss.org ) .
46
45
* Push your changes to the topic branch in your fork of the repository.
47
46
* Initiate a [ pull request] ( http://help.github.com/send-pull-requests/ )
48
- * Update the Jira issue, adding a comment inclusing a link to the created pull request
47
+ * Update the JIRA issue, adding a comment including a link to the created pull request
0 commit comments