Skip to content

Commit c98b75f

Browse files
committedAug 12, 2022
Add section about the iText Development Plugin into the contribution guidelines
1 parent e2f0172 commit c98b75f

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed
 

‎CONTRIBUTING.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ chances of your issue being dealt with quickly:
5757
causing the problem (line of code or commit)
5858
* **Tag the question** - add the tag `itext7` to your question so we can find it.
5959

60-
**If you get help, help others. Good karma rulez!**
60+
**If you get help, consider contributing back to the community by helping others.**
6161

6262

6363
### Submitting a Pull Request
@@ -107,6 +107,17 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
107107
* Wrap all code at **100 characters**.
108108

109109

110+
## iText Development Plugin
111+
If you are using IntelliJ IDEA to make iText contributions, you may find the iText Development Plugin useful.
112+
It contains some code inspections to avoid common problems as well as helper tools to make your work on a pull request more efficient.
113+
114+
In particular, iText has a lot of integration tests where PDF files are created as a result of the test and compared to the reference PDF files.
115+
In case your contribution touches a lot of those files, the reference file replacing utility in the iText Development Plugin may help you fix the tests quicker.
116+
117+
[Download the iText Development Plugin](https://to-be-filled-in)
118+
119+
To install the plugin, use the [official instructions on installing the plugin from disk](https://www.jetbrains.com/help/idea/managing-plugins.html) from Jetbrains.
120+
110121
## <a name="commit">Git Commit Guidelines</a>
111122

112123
We have guidelines on how our git commit messages should be formatted. This leads to **more

0 commit comments

Comments
 (0)
Please sign in to comment.