1
- # Contributing to iText
1
+ # Contributing to iText 7 Community
2
2
3
- We'd love for you to contribute to our source code and to make iText even better than it is
3
+ We'd love for you to contribute to our source code and to make ** iText 7 Community ** even better than it is
4
4
today! Here are the guidelines we'd like you to follow:
5
5
6
6
- [ Question or Problem?] ( #question )
@@ -15,7 +15,7 @@ today! Here are the guidelines we'd like you to follow:
15
15
16
16
## <a name =" question " >Got a Question or Problem?</a >
17
17
18
- If you have questions about how to use iText, please direct these to [ StackOverflow ] [ stackoverflow ] .
18
+ If you have questions about how to use ** iText 7 Community ** , please direct these to [ Stack Overflow ] [ stackoverflow ] .
19
19
20
20
If you are a customer with a [ support agreement] [ support ] , you also have direct access to our JIRA and our developers.
21
21
@@ -32,7 +32,7 @@ If you would like to implement a new feature then consider what kind of change i
32
32
33
33
* ** Major Changes** that you wish to contribute to the project should be discussed first so that we can better
34
34
coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully
35
- accepted into the project.
35
+ accepted into the project.
Contact us at [ [email protected] ] ( mailto:[email protected] ) .
36
36
* ** Small Changes** can be crafted and submitted to the [ GitHub Repository] [ github ] as a [ Pull Request] [ pull ] .
37
37
38
38
@@ -41,7 +41,7 @@ accepted into the project.
41
41
### Submitting a Question or an Issue
42
42
Before you submit your question or issue, search [ Stack Overflow] [ stackoverflow ] , maybe your question was already answered.
43
43
44
- If your issue appears to be a bug, and hasn't been reported, ask a question on [ Stack Overflow] [ stackoverflow ] .
44
+ If your issue appears to be a bug, and hasn't been reported, ask a question on [ Stack Overflow] [ stackoverflow ] to verify that is indeed a bug and not a mistake in your own code .
45
45
Help us to maximize the effort we can spend fixing issues and adding new
46
46
features, by not reporting duplicate issues. Providing the following information will increase the
47
47
chances of your issue being dealt with quickly:
@@ -55,7 +55,7 @@ chances of your issue being dealt with quickly:
55
55
* ** Related Issues** - has a similar issue been reported before?
56
56
* ** Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
57
57
causing the problem (line of code or commit)
58
- * ** Tag the question** - add the tag 'itext' to your question so we can find it.
58
+ * ** Tag the question** - add the tag ` itext7 ` to your question so we can find it.
59
59
60
60
** If you get help, help others. Good karma rulez!**
61
61
@@ -70,11 +70,11 @@ Before you submit your pull request consider the following guidelines:
70
70
* Please sign the [ iText Contributor License Agreement (iCLA)] ( #cla ) before sending pull
71
71
requests for any change of more than 20 significant lines of code (we're not counting curly braces and other syntactical sugar).
72
72
We cannot accept code without this agreement.
73
- * Clone iText to your local machine.
73
+ * Clone ** iText 7 Community ** to your local machine.
74
74
75
75
``` shell
76
- git clone
[email protected] :itext/
itextpdf .git
77
- cd itextpdf
76
+ git clone
[email protected] :itext/
itext7 .git
77
+ cd itext7
78
78
git fetch origin
79
79
git checkout -b develop origin/develop
80
80
```
@@ -87,7 +87,7 @@ Before you submit your pull request consider the following guidelines:
87
87
88
88
* Create your patch, ** including appropriate test cases** .
89
89
* Follow our [Coding Rules](# rules).
90
- * Run the full iText test suite and ensure that all tests pass.
90
+ * Run the full ** iText 7 Community ** test suite and ensure that all tests pass.
91
91
* Commit your changes using a descriptive commit message that follows our
92
92
[commit message conventions](# commit-message-format).
93
93
@@ -96,19 +96,19 @@ Before you submit your pull request consider the following guidelines:
96
96
` ` `
97
97
Note: the optional commit ` -a` command line option will automatically ` add` and ` rm` edited files.
98
98
99
- * Now would be a good time to fix up your commits (if you want or need to) with ` git rebase --interactive` .
99
+ * Now would be a good time to fix up your commits (if you want or need to) with ` git rebase --interactive` .
100
100
* Build your changes locally to ensure all the tests pass.
101
101
* Push your branch to your GitHub account:
102
102
103
103
` ` ` shell
104
- git remote add my-remote [email protected] :my-remote/itextpdf .git
104
+ git remote add my-remote [email protected] :my-remote/itext7 .git
105
105
git push my-remote my-fix-branch
106
106
` ` `
107
107
108
- * In GitHub, send a pull request to ` itextpdf :develop` .
108
+ * In GitHub, send a pull request to ` itext7 :develop` .
109
109
* If we suggest changes then:
110
110
* Make the required updates.
111
- * Re-run the iText test suite to ensure tests are still passing.
111
+ * Re-run the ** iText 7 Community ** test suite to ensure tests are still passing.
112
112
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
113
113
114
114
` ` ` shell
@@ -152,6 +152,9 @@ from the main (upstream) repository:
152
152
## <a name="rules">Coding Rules</a>
153
153
To ensure consistency throughout the source code, keep these rules in mind as you are working:
154
154
155
+ * We develop in Java first, and then port to .NET, so code submissions in Java are preferred.
156
+ Nevertheless this shouldn' t stop you from making a good pull request to the .NET port.
157
+ * All Java code ** must** be Java 7. Sorry, no lambda expressions or other Java 8 language features.
155
158
* All features or bug fixes ** must be tested** by one or more [unit tests][unit-testing].
156
159
* All public API methods ** must be documented** with JavaDoc. To see how we document our APIs, please check
157
160
out the existing [javadocs][javadocs].
@@ -162,9 +165,9 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
162
165
163
166
## <a name="commit">Git Commit Guidelines</a>
164
167
165
- We have very precise rules over how our git commit messages can be formatted. This leads to ** more
168
+ We have guidelines on how our git commit messages should be formatted. This leads to **more
166
169
readable messages** that are easy to follow when looking through the **project history**. But also,
167
- we use the git commit messages to ** generate the iText change log** .
170
+ we use the git commit messages to **generate the iText 7 Community change log**.
168
171
169
172
### Commit Message Format
170
173
Each commit message consists of a **subject**, a **body** and a **footer**:
@@ -177,7 +180,7 @@ Each commit message consists of a **subject**, a **body** and a **footer**:
177
180
<footer>
178
181
```
179
182
180
- Any line of the commit message cannot be longer 70 characters! This allows the message to be easier
183
+ Any line of the commit message should not be longer 70 characters! This allows the message to be easier
181
184
to read on GitHub as well as in various git tools.
182
185
183
186
### Subject
@@ -199,7 +202,7 @@ reference JIRA or GitHub issues that this commit **Closes**.
199
202
200
203
# # <a name="cla">Signing the iCLA</a>
201
204
202
- Please sign the iText Contributor License Agreement (iCLA) before sending pull requests. For any larger code
205
+ Please sign the ** iText Contributor License Agreement (iCLA)** before sending pull requests. For any larger code
203
206
changes (more than 20 lines of significant code) to be accepted, the iCLA must be signed. It' s a quick process, we promise!
204
207
205
208
We' ll need you to [(digitally) sign and then email, fax or mail the form][cla].
@@ -208,20 +211,19 @@ We'll need you to [(digitally) sign and then email, fax or mail the form][cla].
208
211
# # <a name="coc">Contributor Code of Conduct</a>
209
212
Please note that this project is released with a [Contributor Code of Conduct][coc]. By participating in this project you agree to abide by its terms.
210
213
211
- We use the StackExchange network for free support and GitHub for code hosting. By using these services, you agree to abide by their terms:
212
- * StackExchange: http://stackexchange.com/legal
213
- * Github: https://help.github.com/articles/github-terms-of-service/
214
+ We use the [Stack Exchange][stackoverflow] network for free support and [GitHub][github] for code hosting. By using these services, you agree to abide by their terms:
214
215
216
+ * StackExchange: [http://stackexchange.com/legal](http://stackexchange.com/legal)
217
+ * Github: [https://help.github.com/articles/github-terms-of-service/](https://help.github.com/articles/github-terms-of-service/)
215
218
216
219
[cla]: http://itextpdf.com/policy
217
- [coc]: https://github.com/itext/itextpdf/blob/master/CODE_OF_CONDUCT.md
218
- [github]: https://github.com/itext/itextpdf
219
- [itext-dev]: https://lists.sourceforge.net/lists/listinfo/itext-developers
220
+ [coc]: CODE_OF_CONDUCT.md
221
+ [github]: https://github.com/itext/itext7
220
222
[java-style-guide]: http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
221
223
[javadocs]: http://itextpdf.com/api
222
- [pull]: https://github.com/itext/itextpdf /pulls
224
+ [pull]: https://github.com/itext/itext7 /pulls
223
225
[sscce]: http://sscce.org/
224
- [stackoverflow]: http://stackoverflow.com/questions/tagged/itext
226
+ [stackoverflow]: http://stackoverflow.com/questions/tagged/itext7
225
227
[good-questions]: http://stackoverflow.com/help/how-to-ask
226
228
[mcve]: http://stackoverflow.com/help/mcve
227
229
[support]: http://itextpdf.com/support
0 commit comments