Enhanced the contribution guide using IntelliJ IDEA by ZiadAbdElFatah · Pull Request #15022 · JabRef/jabref

ZiadAbdElFatah · 2026-02-03T19:56:48Z

User description

Closes #15012

Enhanced the contribution guide for developers using intillij.

Just open the new contribution guide.

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
I manually tested my changes in running JabRef (always required)
[/] I added JUnit tests for changes (if applicable)
[/] I added screenshots in the PR description (if change is visible to the user)
[/] I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
I checked the user documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

PR Type

Documentation

Description

Updated test example from BibEntryTest to LocalizationConsistencyTest
Replaced outdated screenshot filenames with generic placeholders
Modernized IntelliJ setup guide with current test class references

Diagram Walkthrough

flowchart LR
  A["Old Test Example<br/>BibEntryTest"] -- "Replace with" --> B["New Test Example<br/>LocalizationConsistencyTest"]
  C["Specific Screenshots<br/>12-08, 12-09, etc."] -- "Replace with" --> D["Generic Placeholders<br/>img.png, img_1.png, etc."]
  B --> E["Updated Documentation"]
  D --> E

File Walkthrough

Relevant files

Documentation

intellij-12-build.md `Updated IntelliJ test example documentation` docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.md Changed example test class from `BibEntryTest` to `LocalizationConsistencyTest` throughout the guide Updated test method references from `testDefaultConstructor` to `testfindMissingLocalizationKeys` Replaced specific screenshot filenames (12-08-locate-BibEntryTest.png, etc.) with generic placeholders (img.png, img_1.png, etc.) Updated all figure captions and alt text to reflect the new test class name	+17/-17

qodo-free-for-open-source-projects · 2026-02-03T22:16:34Z

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance

🟢

No security concerns identified

No security vulnerabilities detected by AI analysis. Human verification advised for critical code.

Ticket Compliance

🟡

🎫 #15012

🟢	Rework the 'Final build system checks' section in the IntelliJ build documentation
	Locate and run `LocalizationConsistencyTest` instead of the existing test
	Use test method `findMissingLocalizationKeys` instead of the other one
	Update both text and screenshots in the documentation
⚪	Use Greenshot or Flameshot for screenshots

Codebase Duplication Compliance

⚪

Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance

🟢

Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

qodo-free-for-open-source-projects · 2026-02-03T22:20:27Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Learned best practice	Fix typo in figure caption The caption contains a typographical error: "However" should be "Hover". Correct this to maintain documentation clarity and professionalism. docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.md [170-174] Hover on the green play button on `findMissingLocalizationKeys`: -{% figure caption:"However on green play button" %} -![However on green play button](img_1.png) +{% figure caption:"Hover on green play button" %} +![Hover on green play button](img_1.png) {% endfigure %} Apply / Chat Suggestion importance[1-10]: 6 __ Why: Relevant best practice - Fix typographical errors in documentation to maintain professionalism and clarity	Low
General	✅ ~~Fix inconsistent test method name~~ Suggestion Impact: The documentation was updated to use "Run LocalizationConsistencyTest.findMissingLocalizationKeys" and the corresponding figure caption was adjusted accordingly; related screenshot references were also updated. code diff: Hover on the green play button on `findMissingLocalizationKeys`: {% figure caption:"However on green play button" %} -![However on green play button](img_1.png) +![However on green play button](12-09-run-single-test.png) {% endfigure %} Then, click on it. A popup menu opens. -Choose the first entry "Run LocalizationConsistencyTest.testfindMissingLocalizationKeys" and click on it. - -{% figure caption:"Run LocalizationConsistencyTest.testfindMissingLocalizationKeys" %} -![Popup menu - Run testfindMissingLocalizationKeys](img_2.png) +Choose the first entry "Run LocalizationConsistencyTest.findMissingLocalizationKeys" and click on it. + +{% figure caption:"Run LocalizationConsistencyTest.findMissingLocalizationKeys" %} +![Popup menu - Run testfindMissingLocalizationKeys](12-10-run-single-test-launch-config.png) {% endfigure %} Standardize the test method name to `findMissingLocalizationKeys` throughout the document to resolve an inconsistency. docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.md [170-182] Hover on the green play button on `findMissingLocalizationKeys`: {% figure caption:"However on green play button" %} ![However on green play button](img_1.png) {% endfigure %} Then, click on it. A popup menu opens. -Choose the first entry "Run LocalizationConsistencyTest.testfindMissingLocalizationKeys" and click on it. +Choose the first entry "Run LocalizationConsistencyTest.findMissingLocalizationKeys" and click on it. -{% figure caption:"Run LocalizationConsistencyTest.testfindMissingLocalizationKeys" %} -![Popup menu - Run testfindMissingLocalizationKeys](img_2.png) +{% figure caption:"Run LocalizationConsistencyTest.findMissingLocalizationKeys" %} +![Popup menu - Run findMissingLocalizationKeys](img_2.png) {% endfigure %} `[Suggestion processed]` Suggestion importance[1-10]: 5 __ Why: The suggestion correctly identifies an inconsistency (`findMissingLocalizationKeys` vs. `testfindMissingLocalizationKeys`) introduced by the PR, and the proposed change improves the clarity and correctness of the documentation.	Low
Update

koppor · 2026-02-04T00:53:06Z


 {% figure caption:"However on green play button" %}
-![However on green play button](12-09-run-single-test.png)
+![However on green play button](img_1.png)


Keep the original file pattern please.

koppor · 2026-02-04T00:54:48Z

 Then, the "Search for classes dialog" pops up.
-Enter `bibentrytest`.
-Now, `BibEntryTest` should appear first:
+Enter `LocalizationConsistencyTest`.


Please do lower case - to show that one does not need to spell out in right case.

OK, not sure how I should react on this.

I commented on line 161

You changed line 162

I commented on the search string

You changed the search result.

I am really sorry for this. My apologies.

koppor · 2026-02-04T00:55:16Z

+Now, `LocalizationConsistencyTest` should appear first:

-{% figure caption:"IntelliJ search for class “BibEntryTest”" %}
-![IntelliJ search for class "BibEntryTest"](12-08-locate-BibEntryTest.png)


Remove non-linked images

koppor · 2026-02-04T00:55:45Z


 Press <kbd>Enter</kbd> to jump to that class.

-Hover on the green play button on `defaultConstructor`:


I think, this was intended --> execute whole class.

I think the whole doc intends to guide the user to execute a single test from the test file.

koppor

Last round - either we get my comment addressed - or we close this PR and leave it for someone else.

koppor · 2026-02-07T12:42:32Z

 Then, the "Search for classes dialog" pops up.
-Enter `bibentrytest`.
-Now, `BibEntryTest` should appear first:
+Enter `LocalizationConsistencyTest`.


OK, not sure how I should react on this.

I commented on line 161

You changed line 162

I commented on the search string

You changed the search result.

koppor · 2026-02-07T12:44:55Z


-{% figure caption:"Run BibEntryTest.testDefaultConstructor" %}
-![Popup menu - Run testDefaultConstructor](12-10-run-single-test-launch-config.png)
+{% figure caption:"Run LocalizationConsistencyTest.testfindMissingLocalizationKeys" %}


Why is the wrong test name put as figure caption?

koppor · 2026-02-07T12:47:04Z

 Then, click on it.
 A popup menu opens.
-Choose the first entry "Run BibEntryTest.testDefaultConstructor" and click on it.
+Choose the first entry "Run LocalizationConsistencyTest.testfindMissingLocalizationKeys" and click on it.


Why is the test name wrong?

Please take updates on documentation all newcomers read, seriously.

I can understand that careful work is hard these days. But I cannot lower quality requirements here.

As a reminder: The test method is findMissingLocalizationKeys without test prefix:

jabref/jablib/src/test/java/org/jabref/logic/l10n/LocalizationConsistencyTest.java

Line 129 in 2a584c4

void findMissingLocalizationKeys() throws IOException {

koppor · 2026-02-07T12:47:13Z

+{% figure caption:"Run Tasks for findMissingLocalizationKeys" %}
+![Run Tasks for findMissingLocalizationKeys](12-11-run-task-for-test.png)


Wrong method names

I think these are right I took a copy from the test file and they are still the same.

koppor · 2026-02-07T12:47:31Z

 The tests are green after the run.
 You can also use the play button there to re-execute the tests.
-A right-click on "BibEntryTests" enables the debugger to start.
+A right-click on "findMissingLocalizationKeys" enables the debugger to start.


Well done! Correct method name put!

testlens-app · 2026-02-07T13:38:58Z

✅ All tests passed ✅

🏷️ Commit: ba71174
▶️ Tests: 11185 executed
🟡 Checks: 54/55 completed

Learn more about TestLens at testlens.app.

jabref-machine · 2026-02-08T20:26:49Z

Note that your PR will not be reviewed/accepted until you have gone through the mandatory checks in the description and marked each of them them exactly in the format of [x] (done), [ ] (not done yet) or [/] (not applicable). Please adhere to our pull request template.

koppor

I im a good mood today. I should close the PR. You did appearantly not double check it.

See

What is wrong there??

The casing!!!!!!!!!!!!!!!!!!!!!!!!!! I said to you: Fix the casing. You fixed the casing, but did not think, where it could appear elsewhere.

This was an easy one, because it was at the same screenshot.

At real software, it might be somewhere else.

Please, fix the casing AND REMOVE THE SPACES. See comment below.

If you feel, spaces are easier for noobs, you can leave the spaces in - BUT MAKE THE SCREENSHOT CONSISTENT TO THE TEXT.

koppor · 2026-02-08T20:26:18Z

 Then, the "Search for classes dialog" pops up.
-Enter `bibentrytest`.
-Now, `BibEntryTest` should appear first:
+Enter `localization consistency test`.


Remove the spaces

I am really sorry for that, and thank you for your patience.

ZiadAbdElFatah · 2026-02-08T21:05:42Z

Thank you again for your patience and sorry for the noise I made to you but it's my first time to work on docs @koppor .

ZiadAbdElFatah added 2 commits February 3, 2026 21:52

Enhanced the contribution guide using intellij

da3d8ad

Fix submodules

dd726f7

github-actions Bot added the good first issue An issue intended for project-newcomers. Varies in difficulty. label Feb 3, 2026

github-actions Bot mentioned this pull request Feb 3, 2026

Update DevDocs: run test #15012

Closed

ZiadAbdElFatah marked this pull request as ready for review February 3, 2026 22:16

qodo-free-for-open-source-projects Bot added the Review effort 2/5 label Feb 3, 2026

koppor requested changes Feb 4, 2026

View reviewed changes

github-actions Bot added the status: changes-required Pull requests that are not yet complete label Feb 4, 2026

koppor requested changes Feb 4, 2026

View reviewed changes

ZiadAbdElFatah added 2 commits February 4, 2026 14:54

Enhanced the user guide doc

eeceaf8

Fix submodules

a0772d1

ZiadAbdElFatah requested a review from koppor February 4, 2026 12:55

github-actions Bot removed the status: changes-required Pull requests that are not yet complete label Feb 4, 2026

koppor requested changes Feb 7, 2026

View reviewed changes

github-actions Bot added the status: changes-required Pull requests that are not yet complete label Feb 7, 2026

Fix submodules

befaa09

ZiadAbdElFatah requested a review from koppor February 7, 2026 13:17

github-actions Bot removed the status: changes-required Pull requests that are not yet complete label Feb 7, 2026

koppor changed the title ~~Enhanced the contribution guide using intillij~~ Enhanced the contribution guide using IntelliJ IDEA Feb 8, 2026

koppor requested changes Feb 8, 2026

View reviewed changes

github-actions Bot added the status: changes-required Pull requests that are not yet complete label Feb 8, 2026

ZiadAbdElFatah added 3 commits February 8, 2026 22:37

Fixed screenshot

bef89cb

Merge remote-tracking branch 'origin/main' into fix-for-issue-15012

b6180e6

Fix submodules

ba71174

koppor approved these changes Feb 8, 2026

View reviewed changes

koppor enabled auto-merge February 8, 2026 21:02

koppor added this pull request to the merge queue Feb 8, 2026

github-actions Bot added the status: to-be-merged PRs which are accepted and should go into the merge-queue. label Feb 8, 2026

Merged via the queue into JabRef:main with commit 008cf01 Feb 8, 2026
55 checks passed

ZiadAbdElFatah deleted the fix-for-issue-15012 branch February 8, 2026 21:43


		Press <kbd>Enter</kbd> to jump to that class.

		Hover on the green play button on `defaultConstructor`:

		{% figure caption:"Run Tasks for findMissingLocalizationKeys" %}
		![Run Tasks for findMissingLocalizationKeys](12-11-run-task-for-test.png)

Uh oh!

Conversation

ZiadAbdElFatah commented Feb 3, 2026 • edited by qodo-free-for-open-source-projects Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

Mandatory checks

PR Type

Description

Diagram Walkthrough

File Walkthrough

Uh oh!

qodo-free-for-open-source-projects Bot commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Compliance Guide 🔍

Uh oh!

qodo-free-for-open-source-projects Bot commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions ✨

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

testlens-app Bot commented Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ All tests passed ✅

Uh oh!

jabref-machine commented Feb 8, 2026

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ZiadAbdElFatah commented Feb 8, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ZiadAbdElFatah commented Feb 3, 2026 •

edited by qodo-free-for-open-source-projects Bot

Loading

qodo-free-for-open-source-projects Bot commented Feb 3, 2026 •

edited

Loading

qodo-free-for-open-source-projects Bot commented Feb 3, 2026 •

edited

Loading

testlens-app Bot commented Feb 7, 2026 •

edited

Loading