Skip to content

Fix typo in IntelliJ IDEA code style instructions#14693

Merged
koppor merged 1 commit into
JabRef:mainfrom
LangInteger:patch-1
Dec 23, 2025
Merged

Fix typo in IntelliJ IDEA code style instructions#14693
koppor merged 1 commit into
JabRef:mainfrom
LangInteger:patch-1

Conversation

@LangInteger

@LangInteger LangInteger commented Dec 23, 2025 •
edited by qodo-code-review Bot
Loading

Copy link
Copy Markdown
Contributor

User description

Steps to test

The figure right after the text shows"Reformat code" instead of "Reformat on code" and it aligns with IntelliJ IDEA UI in my local computer. The figure is imported by:

{% figure caption:"Enable autoformatting on save" %}
![Enable autoformatting on save](13-12.5-auto-formatting.png)
{% endfigure %}

The figure is put here for easier review.

image

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

  • Corrects typo in IntelliJ IDEA code style setup instructions

  • Changes "Reformat on code" to "Reformat code" to match actual UI

Diagram Walkthrough

flowchart LR
  A["Documentation File"] -- "Fix typo in instruction" --> B["Correct UI label reference"]
Loading

File Walkthrough
Relevant files
Documentation
intellij-13-code-style.md
Fix typo in code formatting instruction                                   

docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.md

  • Corrects step 1 instruction from "Reformat on code" to "Reformat code"
  • Aligns documentation with actual IntelliJ IDEA UI label
 +1/-1     

@github-actions

github-actions Bot commented Dec 23, 2025

Copy link
Copy Markdown
Contributor

Hey @LangInteger! 👋

Thank you for contributing to JabRef!

We have automated checks in place, based on which you will soon get feedback if any of them are failing.

After all automated checks pass, a maintainer will also review your contribution. Once that happens, you can go through their comments in the "Files changed" tab and act on them, or reply to the conversation if you have further inputs.

Please re-check our AI Usage Policy to ensure that your pull request is in line with it. It also contains links to our contribution guide in case of any other doubts related to our contribution workflow.

@qodo-code-review

qodo-code-review Bot commented Dec 23, 2025

Copy link
Copy Markdown
Contributor

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
⚪
🎫 No ticket provided
  • Create ticket/issue
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
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-code-review

qodo-code-review Bot commented Dec 23, 2025

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

No code suggestions found for the PR.

@koppor

koppor commented Dec 23, 2025

Copy link
Copy Markdown
Member

@LangInteger Thank you for the PR. This is exactly why we made the documentation in Markdown.

@koppor koppor merged commit b3c0ea5 into JabRef:main Dec 23, 2025
66 of 77 checks passed
Siedlerchr added a commit that referenced this pull request Dec 23, 2025
@Siedlerchr
Merge branch 'main' into improveCleanup
9a79580 
* main:
  Update AI usage policy (#14698)
  Fix handling of DOIs (#14704)
  Handle ohter CrossRef response (#14696)
  Fix condition for processing closed issues/PRs
  Translate the English "change to Chinese(simplified)" to the Chinese in the warning dialog (#14690)
  More performance optimization (#14695)
  Add missing dot (and a link)
  Add link to PR template also if checklist is present, but not OK (#14694)
  Fix typo in IntelliJ code style instructions (#14693)
  Add import into new library to Welcome Tab (#14669)
  Add initial search requirements (#14633)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@koppor koppor koppor approved these changes

Assignees

No one assigned

Labels

first contrib Review effort 1/5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@LangInteger @koppor