-
Notifications
You must be signed in to change notification settings - Fork 461
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'release/5.5.13.2' into master
- Loading branch information
Showing
1,377 changed files
with
1,784 additions
and
1,514 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Contributing to iText | ||
| # Contributing to iText 7 Community | ||
|
|
||
| We'd love for you to contribute to our source code and to make iText even better than it is | ||
| We'd love for you to contribute to our source code and to make **iText 7 Community** even better than it is | ||
| today! Here are the guidelines we'd like you to follow: | ||
|
|
||
| - [Question or Problem?](#question) | ||
|
|
@@ -15,7 +15,7 @@ today! Here are the guidelines we'd like you to follow: | |
|
|
||
| ## <a name="question">Got a Question or Problem?</a> | ||
|
|
||
| If you have questions about how to use iText, please direct these to [StackOverflow][stackoverflow]. | ||
| If you have questions about how to use **iText 7 Community**, please direct these to [Stack Overflow][stackoverflow]. | ||
|
|
||
| If you are a customer with a [support agreement][support], you also have direct access to our JIRA and our developers. | ||
|
|
||
|
|
@@ -32,7 +32,7 @@ If you would like to implement a new feature then consider what kind of change i | |
|
|
||
| * **Major Changes** that you wish to contribute to the project should be discussed first so that we can better | ||
| coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully | ||
| accepted into the project. | ||
| accepted into the project. Contact us at [[email protected]](mailto:[email protected]). | ||
| * **Small Changes** can be crafted and submitted to the [GitHub Repository][github] as a [Pull Request][pull]. | ||
|
|
||
|
|
||
|
|
@@ -41,7 +41,7 @@ accepted into the project. | |
| ### Submitting a Question or an Issue | ||
| Before you submit your question or issue, search [Stack Overflow][stackoverflow], maybe your question was already answered. | ||
|
|
||
| If your issue appears to be a bug, and hasn't been reported, ask a question on [Stack Overflow][stackoverflow]. | ||
| 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. | ||
| Help us to maximize the effort we can spend fixing issues and adding new | ||
| features, by not reporting duplicate issues. Providing the following information will increase the | ||
| chances of your issue being dealt with quickly: | ||
|
|
@@ -55,7 +55,7 @@ chances of your issue being dealt with quickly: | |
| * **Related Issues** - has a similar issue been reported before? | ||
| * **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be | ||
| causing the problem (line of code or commit) | ||
| * **Tag the question** - add the tag 'itext' to your question so we can find it. | ||
| * **Tag the question** - add the tag `itext7` to your question so we can find it. | ||
|
|
||
| **If you get help, help others. Good karma rulez!** | ||
|
|
||
|
|
@@ -70,88 +70,37 @@ Before you submit your pull request consider the following guidelines: | |
| * Please sign the [iText Contributor License Agreement (iCLA)](#cla) before sending pull | ||
| requests for any change of more than 20 significant lines of code (we're not counting curly braces and other syntactical sugar). | ||
| We cannot accept code without this agreement. | ||
| * Clone iText to your local machine. | ||
|
|
||
| ```shell | ||
| git clone [email protected]:itext/itextpdf.git | ||
| cd itextpdf | ||
| git fetch origin | ||
| git checkout -b develop origin/develop | ||
| ``` | ||
|
|
||
| * Make your changes in a new git branch based off the develop branch: | ||
|
|
||
| ```shell | ||
| git checkout -b my-fix-branch develop | ||
| ``` | ||
|
|
||
| * Create your patch, **including appropriate test cases**. | ||
| * Fork the iText repository on GitHub. | ||
| * Clone your iText fork to your local machine. | ||
| * Make your changes, **including appropriate test cases**. | ||
| * Follow our [Coding Rules](#rules). | ||
| * Run the full iText test suite and ensure that all tests pass. | ||
| * Commit your changes using a descriptive commit message that follows our | ||
| [commit message conventions](#commit-message-format). | ||
|
|
||
| ```shell | ||
| git commit -a | ||
| ``` | ||
| Note: the optional commit `-a` command line option will automatically `add` and `rm` edited files. | ||
|
|
||
| * Now would be a good time to fix up your commits (if you want or need to) with `git rebase --interactive`. | ||
| * Now would be a good time to fix up your commits (if you want or need to) with `git rebase --interactive`. | ||
| * Build your changes locally to ensure all the tests pass. | ||
| * Push your branch to your GitHub account: | ||
|
|
||
| ```shell | ||
| git remote add my-remote [email protected]:my-remote/itextpdf.git | ||
| git push my-remote my-fix-branch | ||
| ``` | ||
|
|
||
| * In GitHub, send a pull request to `itextpdf:develop`. | ||
| * Push your changes to your GitHub account. | ||
| * Create a pull request in GitHub. | ||
| "Head fork" should be your repository, and the "base fork" should be the iText7 official repository. | ||
| * If we suggest changes then: | ||
| * Make the required updates. | ||
| * Re-run the iText test suite to ensure tests are still passing. | ||
| * Rebase your branch and force push to your GitHub repository (this will update your Pull Request): | ||
|
|
||
| ```shell | ||
| git fetch origin | ||
| git rebase develop -i | ||
| git push my-remote my-fix-branch -f | ||
| ``` | ||
| * Fix up your commits if needed, with an interactive rebase. | ||
| * Re-run the tests and make sure that they are still passing. | ||
| * Force push to your GitHub repository. This will update your Pull Request. | ||
|
|
||
| That's it! Thank you for your contribution! | ||
|
|
||
| #### After your pull request is merged | ||
|
|
||
| After your pull request is merged, you can safely delete your branch and pull the changes | ||
| from the main (upstream) repository: | ||
| * Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: | ||
| ```shell | ||
| git push my-remote --delete my-fix-branch | ||
| ``` | ||
| * Check out the develop branch: | ||
| ```shell | ||
| git checkout develop -f | ||
| ``` | ||
| * Delete the local branch: | ||
| ```shell | ||
| git branch -D my-fix-branch | ||
| ``` | ||
| * Update your develop with the latest upstream version: | ||
| ```shell | ||
| git pull --ff upstream develop | ||
| ``` | ||
| After your pull request is merged, you can safely delete your fork and pull the changes | ||
| from the main (upstream) repository. | ||
|
|
||
|
|
||
| ## <a name="rules">Coding Rules</a> | ||
| To ensure consistency throughout the source code, keep these rules in mind as you are working: | ||
|
|
||
| * We develop in Java first, and then port to .NET, so code submissions in Java are preferred. | ||
| Nevertheless this shouldn't stop you from making a good pull request to the .NET port. | ||
| * All Java code **must** be Java 7. Sorry, no lambda expressions or other Java 8 language features. | ||
| * All features or bug fixes **must be tested** by one or more [unit tests][unit-testing]. | ||
| * All public API methods **must be documented** with JavaDoc. To see how we document our APIs, please check | ||
| out the existing [javadocs][javadocs]. | ||
|
|
@@ -162,9 +111,11 @@ To ensure consistency throughout the source code, keep these rules in mind as yo | |
|
|
||
| ## <a name="commit">Git Commit Guidelines</a> | ||
|
|
||
| We have very precise rules over how our git commit messages can be formatted. This leads to **more | ||
| We have guidelines on how our git commit messages should be formatted. This leads to **more | ||
| readable messages** that are easy to follow when looking through the **project history**. But also, | ||
| we use the git commit messages to **generate the iText change log**. | ||
| we use the git commit messages to **generate the iText 7 Community change log**. | ||
|
|
||
| These guidelines were taken from Chris Beams' blog post [How to Write a Git Commit Message][git-commit]. | ||
|
|
||
| ### Commit Message Format | ||
| Each commit message consists of a **subject**, a **body** and a **footer**: | ||
|
|
@@ -177,29 +128,30 @@ Each commit message consists of a **subject**, a **body** and a **footer**: | |
| <footer> | ||
| ``` | ||
|
|
||
| Any line of the commit message cannot be longer 70 characters! This allows the message to be easier | ||
| Any line of the commit message should not be longer 72 characters! This allows the message to be easier | ||
| to read on GitHub as well as in various git tools. | ||
|
|
||
| ### Subject | ||
| The subject contains succinct description of the change: | ||
|
|
||
| * use the imperative, present tense: "change" not "changed" nor "changes" | ||
| * don't capitalize first letter | ||
| * no dot (.) at the end | ||
| * describe what the **change** does, not the actions the developer has done | ||
| * [Separate subject from body with a blank line][git-commit-separate] | ||
| * [Limit the subject line to 50 characters][git-commit-limit-50] | ||
| * [Capitalize the subject line][git-commit-capitalize] | ||
| * [Do not end the subject line with a period][git-commit-end] | ||
| * [Use the imperative mood in the subject line][git-commit-imperative] | ||
|
|
||
| ### Body | ||
| Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". | ||
| The body should include the motivation for the change and contrast this with previous behavior. | ||
| * [Wrap the body at 72 characters][git-commit-wrap-72] | ||
| * [Use the body to explain _what_ and _why_ vs. _how_][git-commit-why-not-how] | ||
|
|
||
| ### Footer | ||
| The footer should contain any information about **Breaking Changes** and is also the place to | ||
| The footer contains any information about **Breaking Changes** and is also the place to | ||
| reference JIRA or GitHub issues that this commit **Closes**. | ||
|
|
||
|
|
||
| ## <a name="cla">Signing the iCLA</a> | ||
|
|
||
| Please sign the iText Contributor License Agreement (iCLA) before sending pull requests. For any larger code | ||
| Please sign the **iText Contributor License Agreement (iCLA)** before sending pull requests. For any larger code | ||
| changes (more than 20 lines of significant code) to be accepted, the iCLA must be signed. It's a quick process, we promise! | ||
|
|
||
| We'll need you to [(digitally) sign and then email, fax or mail the form][cla]. | ||
|
|
@@ -208,21 +160,28 @@ We'll need you to [(digitally) sign and then email, fax or mail the form][cla]. | |
| ## <a name="coc">Contributor Code of Conduct</a> | ||
| 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. | ||
|
|
||
| We use the StackExchange network for free support and GitHub for code hosting. By using these services, you agree to abide by their terms: | ||
| * StackExchange: http://stackexchange.com/legal | ||
| * Github: https://help.github.com/articles/github-terms-of-service/ | ||
| 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: | ||
|
|
||
| * StackExchange: [http://stackexchange.com/legal](http://stackexchange.com/legal) | ||
| * Github: [https://help.github.com/articles/github-terms-of-service/](https://help.github.com/articles/github-terms-of-service/) | ||
|
|
||
| [cla]: http://itextpdf.com/policy | ||
| [coc]: https://github.com/itext/itextpdf/blob/master/CODE_OF_CONDUCT.md | ||
| [github]: https://github.com/itext/itextpdf | ||
| [itext-dev]: https://lists.sourceforge.net/lists/listinfo/itext-developers | ||
| [coc]: CODE_OF_CONDUCT.md | ||
| [github]: https://github.com/itext/itext7 | ||
| [java-style-guide]: http://www.oracle.com/technetwork/java/codeconvtoc-136057.html | ||
| [javadocs]: http://itextpdf.com/api | ||
| [pull]: https://github.com/itext/itextpdf/pulls | ||
| [pull]: https://github.com/itext/itext7/pulls | ||
| [sscce]: http://sscce.org/ | ||
| [stackoverflow]: http://stackoverflow.com/questions/tagged/itext | ||
| [stackoverflow]: http://stackoverflow.com/questions/tagged/itext7 | ||
| [good-questions]: http://stackoverflow.com/help/how-to-ask | ||
| [mcve]: http://stackoverflow.com/help/mcve | ||
| [support]: http://itextpdf.com/support | ||
| [unit-testing]: http://junit.org/ | ||
| [git-commit]: https://chris.beams.io/posts/git-commit/ | ||
| [git-commit-separate]: https://chris.beams.io/posts/git-commit/#separate | ||
| [git-commit-limit-50]: https://chris.beams.io/posts/git-commit/#limit-50 | ||
| [git-commit-capitalize]: https://chris.beams.io/posts/git-commit/#capitalize | ||
| [git-commit-end]: https://chris.beams.io/posts/git-commit/#end | ||
| [git-commit-imperative]: https://chris.beams.io/posts/git-commit/#imperative | ||
| [git-commit-wrap-72]: https://chris.beams.io/posts/git-commit/#wrap-72 | ||
| [git-commit-why-not-how]: https://chris.beams.io/posts/git-commit/#why-not-how | ||
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
itext/src/main/java/com/itextpdf/awt/geom/PolylineShapeIterator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.