You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
***Small Changes** can be crafted and submitted to the [GitHub Repository][github] as a [Pull Request][pull].
34
37
35
-
## <aname="submit"></a> Submission Guidelines
36
38
37
-
### Submitting an Issue
38
-
Before you submit your issue, search [Stack Overflow][stackoverflow], maybe your question was already answered.
39
+
## <aname="submit">Submission Guidelines</a>
40
+
41
+
### Submitting a Question or an Issue
42
+
Before you submit your question or issue, search [Stack Overflow][stackoverflow], maybe your question was already answered.
39
43
40
-
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.
41
45
Help us to maximize the effort we can spend fixing issues and adding new
42
46
features, by not reporting duplicate issues. Providing the following information will increase the
43
47
chances of your issue being dealt with quickly:
44
48
49
+
***[How to ask good questions][good-questions]**
45
50
***Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
46
51
***Motivation for or Use Case** - explain why this is a bug for you
47
52
***iText Version(s)** - is it a regression?
48
53
***Operating System** - is this a problem on Windows or Linux, maybe on Mac?
49
-
***Reproduce the Error** - provide a [Short, Self Contained, Correct (Compilable), Example][sscce].
54
+
***Reproduce the Error** - provide a [Short, Self Contained, Correct (Compilable), Example][sscce], also known as a [Minimal, Complete, and Verifiable example][mcve].
50
55
***Related Issues** - has a similar issue been reported before?
51
56
***Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
52
57
causing the problem (line of code or commit)
53
-
***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.
54
59
55
60
**If you get help, help others. Good karma rulez!**
56
61
@@ -65,99 +70,52 @@ Before you submit your pull request consider the following guidelines:
65
70
* Please sign the [iText Contributor License Agreement (iCLA)](#cla) before sending pull
66
71
requests for any change of more than 20 significant lines of code (we're not counting curly braces and other syntactical sugar).
* In GitHub, send a pull request to `itextpdf:develop`.
81
+
* Push your changes to your GitHub account.
82
+
* Create a pull request in GitHub.
83
+
"Head fork" should be your repository, and the "base fork" should be the iText7 official repository.
104
84
* If we suggest changes then:
105
85
* Make the required updates.
106
-
* Re-run the iText test suite to ensure tests are still passing.
107
-
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
108
-
109
-
```shell
110
-
git fetch origin
111
-
git rebase develop -i
112
-
git push my-remote my-fix-branch -f
113
-
```
86
+
* Fix up your commits if needed, with an interactive rebase.
87
+
* Re-run the tests and make sure that they are still passing.
88
+
* Force push to your GitHub repository. This will update your Pull Request.
114
89
115
90
That's it! Thank you for your contribution!
116
91
117
92
#### After your pull request is merged
118
93
119
-
After your pull request is merged, you can safely delete your branch and pull the changes
120
-
from the main (upstream) repository:
94
+
After your pull request is merged, you can safely delete your fork and pull the changes
95
+
from the main (upstream) repository.
121
96
122
-
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
123
97
124
-
```shell
125
-
git push my-remote --delete my-fix-branch
126
-
```
127
-
128
-
* Check out the develop branch:
129
-
130
-
```shell
131
-
git checkout develop -f
132
-
```
133
-
134
-
* Delete the local branch:
135
-
136
-
```shell
137
-
git branch -D my-fix-branch
138
-
```
139
-
140
-
* Update your develop with the latest upstream version:
141
-
142
-
```shell
143
-
git pull --ff upstream develop
144
-
```
145
-
146
-
## <a name="rules"></a> Coding Rules
98
+
## <aname="rules">Coding Rules</a>
147
99
To ensure consistency throughout the source code, keep these rules in mind as you are working:
148
100
101
+
* We develop in Java first, and then port to .NET, so code submissions in Java are preferred.
102
+
Nevertheless this shouldn't stop you from making a good pull request to the .NET port.
103
+
* All Java code **must** be Java 7. Sorry, no lambda expressions or other Java 8 language features.
149
104
* All features or bug fixes **must be tested** by one or more [unit tests][unit-testing].
150
105
* All public API methods **must be documented** with JavaDoc. To see how we document our APIs, please check
151
106
out the existing [javadocs][javadocs].
152
107
* We follow the rules contained in
153
108
[Oracle's Code Conventions for the Java Programming Language][java-style-guide], with these additions:
154
109
* Wrap all code at **100 characters**.
155
110
156
-
## <a name="commit"></a> Git Commit Guidelines
157
111
158
-
We have very precise rules over how our git commit messages can be formatted. This leads to **more
112
+
## <aname="commit">Git Commit Guidelines</a>
113
+
114
+
We have guidelines on how our git commit messages should be formatted. This leads to **more
159
115
readable messages** that are easy to follow when looking through the **project history**. But also,
160
-
we use the git commit messages to **generate the iText change log**.
116
+
we use the git commit messages to **generate the iText 7 Community change log**.
117
+
118
+
These guidelines were taken from Chris Beams' blog post [How to Write a Git Commit Message][git-commit].
161
119
162
120
### Commit Message Format
163
121
Each commit message consists of a **subject**, a **body** and a **footer**:
@@ -170,41 +128,60 @@ Each commit message consists of a **subject**, a **body** and a **footer**:
170
128
<footer>
171
129
```
172
130
173
-
Any line of the commit message cannot be longer 70 characters! This allows the message to be easier
131
+
Any line of the commit message should not be longer 72 characters! This allows the message to be easier
174
132
to read on GitHub as well as in various git tools.
175
133
176
134
### Subject
177
135
The subject contains succinct description of the change:
178
136
179
-
* use the imperative, present tense: "change" not "changed" nor "changes"
180
-
* don't capitalize first letter
181
-
* no dot (.) at the end
182
-
* describe what the **change** does, not the actions the developer has done
137
+
*[Separate subject from body with a blank line][git-commit-separate]
138
+
*[Limit the subject line to 50 characters][git-commit-limit-50]
139
+
*[Capitalize the subject line][git-commit-capitalize]
140
+
*[Do not end the subject line with a period][git-commit-end]
141
+
*[Use the imperative mood in the subject line][git-commit-imperative]
183
142
184
143
### Body
185
-
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
186
-
The body should include the motivation for the change and contrast this with previous behavior.
144
+
*[Wrap the body at 72 characters][git-commit-wrap-72]
145
+
*[Use the body to explain _what_ and _why_ vs. _how_][git-commit-why-not-how]
187
146
188
147
### Footer
189
-
The footer should contain any information about **Breaking Changes** and is also the place to
148
+
The footer contains any information about **Breaking Changes** and is also the place to
190
149
reference JIRA or GitHub issues that this commit **Closes**.
191
150
192
-
## <a name="cla"></a> Signing the iCLA
193
151
194
-
Please sign the iText Contributor License Agreement (iCLA) before sending pull requests. For any larger code
152
+
## <aname="cla">Signing the iCLA</a>
153
+
154
+
Please sign the **iText Contributor License Agreement (iCLA)** before sending pull requests. For any larger code
195
155
changes (more than 20 lines of significant code) to be accepted, the iCLA must be signed. It's a quick process, we promise!
196
156
197
157
We'll need you to [(digitally) sign and then email, fax or mail the form][cla].
198
158
199
159
160
+
## <aname="coc">Contributor Code of Conduct</a>
161
+
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.
162
+
163
+
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:
<description>PLEASE NOTE: iTextSharp is EOL, and has been replaced by iText 7. Only security fixes will be added
14
+
15
+
We HIGHLY recommend customers use iText 7 for new projects, and to consider moving existing projects from iTextSharp to iText 7 to benefit from the many improvements such as:
16
+
- HTML to PDF (PDF/A) conversion
17
+
- PDF Redaction
18
+
- SVG support
19
+
- Better language support (Indic, Thai, Khmer, Arabic, Hebrew)
20
+
- PDF Debugging for your IDE
21
+
- Data Extraction
22
+
- Better continued support and bugfixes
23
+
- More modular, extensible handling of your document workflow
24
+
- Extra practical add-ons
25
+
- Encryption, hashing and digital signatures
26
+
27
+
This DEPRECATED library adds extra functionality for iTextSharp. Please use iText 7 instead. iText 7 Community: https://www.nuget.org/packages/itext7/ and iText 7 pdfSweep addon: https://www.nuget.org/packages/itext7.pdfsweep/</description>
28
+
<summary>Extra functionality for DEPRECACTED iTextSharp PDF generation library written entirely in C# for the .NET platform. Please use iText 7 instead.
<description>PLEASE NOTE: iTextSharp is EOL, and has been replaced by iText 7. Only security fixes will be added
14
+
15
+
We HIGHLY recommend customers use iText 7 for new projects, and to consider moving existing projects from iTextSharp to iText 7 to benefit from the many improvements such as:
16
+
- HTML to PDF (PDF/A) conversion
17
+
- PDF Redaction
18
+
- SVG support
19
+
- Better language support (Indic, Thai, Khmer, Arabic, Hebrew)
20
+
- PDF Debugging for your IDE
21
+
- Data Extraction
22
+
- Better continued support and bugfixes
23
+
- More modular, extensible handling of your document workflow
24
+
- Extra practical add-ons
25
+
- Encryption, hashing and digital signatures
26
+
27
+
This DEPRECATED library adds extra functionality for iTextSharp. Please use iText 7 instead. iText 7 Community: https://www.nuget.org/packages/itext7/ and iText 7 pdfSweep addon: https://www.nuget.org/packages/itext7.pdfsweep/</description>
28
+
<summary>Extra functionality for DEPRECACTED iTextSharp PDF generation library written entirely in C# for the .NET platform. Please use iText 7 instead.
0 commit comments