1
1
Guidelines for contributing to Hibernate Validator
2
2
====
3
+
3
4
Contributions from the community are essential in keeping Hibernate Validator strong and successful.
4
5
This guide focuses on how to contribute back to Hibernate Validator using GitHub pull requests.
5
6
If you need help with cloning, compiling or setting the project up in an IDE please refer to
6
7
[ this page] ( http://hibernate.org/validator/contribute/ ) .
7
8
9
+ ## Legal
10
+
11
+ All original contributions to Hibernate Validator are licensed under the
12
+ [ Apache License version 2.0] ( https://www.apache.org/licenses/LICENSE-2.0 ) ,
13
+ or, if another license is specified as governing the file or directory being
14
+ modified, such other license. The Apache License text is included verbatim in the [ license.txt] ( license.txt ) file
15
+ in the root directory of the repository.
16
+
17
+ All contributions are subject to the [ Developer Certificate of Origin (DCO)] ( https://developercertificate.org/ ) .
18
+ The DCO text is also included verbatim in the [ dco.txt] ( dco.txt ) file in the root directory of the repository.
19
+
8
20
## Getting Started
21
+
9
22
If you are just getting started with Git, GitHub and/or contributing to Hibernate Validator there are a
10
23
few prerequisite steps:
11
24
12
25
* Make sure you have a [ Hibernate JIRA account] ( https://hibernate.atlassian.net )
13
26
* Make sure you have a [ GitHub account] ( https://github.com/signup/free )
14
- * [ Fork] ( http ://help.github.com/fork-a-repo) the Hibernate Validator [ repository] ( https://github.com/hibernate/hibernate-validator ) .
27
+ * [ Fork] ( https ://help.github.com/articles/ fork-a-repo/ ) the Hibernate Validator [ repository] ( https://github.com/hibernate/hibernate-validator ) .
15
28
As discussed in the linked page, this also includes:
16
- * [ Setting] ( https://help.github.com/articles/set-up-git ) up your local git install
29
+ * [ Setting] ( https://help.github.com/articles/set-up-git/ ) up your local git install
17
30
* Cloning your fork
18
31
19
32
## Create a test case
@@ -27,6 +40,7 @@ projects](https://github.com/hibernate/hibernate-test-case-templates).
27
40
Just fork this repository, build your test case and attach it as an archive to a JIRA issue.
28
41
29
42
## Create a topic branch
43
+
30
44
Create a "topic" branch on which you will work. The convention is to name the branch
31
45
using the JIRA issue key. If there is not already a JIRA issue covering the work you
32
46
want to do, create one. Assuming you will be working from the master branch and working
@@ -77,7 +91,7 @@ git pull --rebase upstream master
77
91
```
78
92
79
93
## Submit
80
- * Sign the [ Contributor License Agreement ] ( https://cla.jboss.org/ ) for the Hibernate Validator project.
94
+
81
95
* Push your changes to a topic branch in your fork of the repository.
82
- * Initiate a [ pull request] ( http ://help.github.com/send- pull-requests /) .
96
+ * Initiate a [ pull request] ( https ://help.github.com/articles/creating-a- pull-request-from-a-fork /) .
83
97
* Update the JIRA issue, adding a comment including a link to the created pull request.
0 commit comments