Skip to content

Latest commit

 

History

History
177 lines (116 loc) · 10.7 KB

CONTRIBUTING.md

File metadata and controls

177 lines (116 loc) · 10.7 KB
Raw

Contributing

General overview about contributing for non-programmers is available at https://docs.jabref.org/contributing.

We welcome contributions to JabRef and encourage you to follow the GitHub workflow specified below. If you are not familiar with this type of workflow, take a look at GitHub's excellent overview on the GitHub flow and the explanation of Feature Branch Workflow for the idea behind this kind of development.

Before you start, get the JabRef code on your local machine. Detailed instructions about this step can be found in our guidelines for setting up a local workspace.

Table of Contents

Choosing a task Join the chat at https://gitter.im/JabRef/jabref

In general, we offer small issues perfect for aspiring developers. These tasks provide an opportunity to learn how to set up your local workspace, create your first pull request on GitHub, and contribute towards solving minor problems or making small enhancements in JabRef.

It is essential to note that JabRef's issues vary in difficulty. Some are simpler, while others are more complex. Our primary aim is to guide you through the code, ensuring that the understanding scope remains manageable. Sometimes, grasping the code might demand more effort than actually writing lines of code.

I am a student and I want to start with something easy

We collect good issues to start with at our list of good first issues.

I am a student and I want to choose from a curated list of university projects

Take a look at JabRef's candidates for university projects. There, a list of possible projects to work on during a teaching period is offered.

I am a lecturer

If you ask yourself how to integrate JabRef into your class, please read the documentation about how to integrate JabRef into a class of software engineering training. As student, you may notify your lecturer about this possibility.

I want something with huge impact

Look at the discussions in our forum about new features. Find an interesting topic, discuss it and start contributing. Alternatively, you can check out JabRef's projects page at GitHub. Although, of course, you can choose to work on ANY issue, choosing from the projects page has the advantage that these issues have already been categorized, sorted and screened by JabRef maintainers. A typical subclassifications scheme is "priority" (high, normal and low). Fixing high priority issues is preferred.

I want to know how to contribute code and set up my workspace

Check out the documentation for developers

I want to improve the developer's documentation

For improving developer's documentation, go on at the docs/ subdirectory of JabRef's code and edit the file. GitHub offers a good guide at Editing files in another user's repository. One can also add callouts.

Getting a task assigned

Comment on the issue you want to work at with /assign-me. GitHub will then automatically assign you.

Pull Request Process

  1. Follow the steps at Pre Condition 3: Code on the local machine to a) create a fork and b) have the fork checked out on your local machine
  2. Ensure that you followed the steps to set up a local workspace to have the code running properly in IntelliJ.
  3. Create a new branch (such as fix-for-issue-121). Be sure to create a separate branch for each improvement you implement.
  4. Work on the new branch — not the main branch. Refer to our code how-tos if you have questions about your implementation.
  5. Create a pull request to JabRef main repository. For an overview on the concept of pull requests, take a look at GitHub's pull request help documentation.
    1. Ensure that you followed the requirements listed below. They are not too hard, they merely support the maintainers to focus on supportive feedback than just stating the obvious.
    2. For text inspirations, consider How to write the perfect pull request.
    3. In case your pull request is not yet complete or not yet ready for review, create a draft pull request instead.
  6. Wait for feedback of the developers
  7. Address the feedback of the developers
  8. After two developers gave their green flag, the pull request will be merged.

In case you have any questions, please

  1. comment on the issue,
  2. show up in our Gitter chat, or
  3. show your current code using a draft pull request and ask questions.

We favor looking into your code using a draft pull request, because we can then also load the code into our IDE. As counterexample, if you provide us with a screenshot of your changes, we cannot run it in our IDE.

Requirements on the pull request and code

Test your code

We know that writing test cases takes a lot of time. Nevertheless, we rely on our test cases to ensure that a bug fix or a feature implementation does not break anything.

For UI changes, we know that test cases are hard to write. Therefore, you can omit them. However, please at least add a screenshot showing your changes to the request.

Write a good commit message

See good commit message or commit guidelines section of Pro Git. For the curious: Why good commit messages matter!. The first line of your commit message is automatically taken as the title for the pull-request. All other lines make up the body of the pull request. Add the words fixes #xxx to your PR to auto-close the corresponding issue.

Add your change to CHANGELOG.md

You should edit the CHANGELOG.md file located in the root directory of the JabRef source. Add a line with your changes in the appropriate section.

If you did internal refactorings or improvements not visible to the user (e.g., UI, .bib file), then you don't need to put an entry there.

Author credits

Please, do not add yourself at JavaDoc's @authors. The contribution information is tracked via the version control system and shown at https://github.com/JabRef/jabref/graphs/contributors. We also show all contributors in our blog posts. See Release 5.15 blog post for an example.

Your contribution is considered being made under MIT license.

Notes on AI usage

Please keep these two principles in mind when you contribute:

  1. Never let an LLM speak for you.
  2. Never let an LLM think for you.

More reading on that is available at https://roe.dev/blog/using-ai-in-open-source.

We reserve the right to reject pull requests that contain little or no genuine and original contribution from the contributor.

Development hints

When adding an external dependency

Please try to use a version available at JCenter and add it to build.gradle. In any case, describe the library at external-libraries.md. We need that information for our package maintainers (e.g., those of the debian package).

When making an architectural decision

In case you add a library or do major code rewrites, we ask you to document your decision. Recommended reading: https://adr.github.io/.

We simply ask to create a new markdown file in docs/adr following the template presented at https://adr.github.io/madr/. You can link that ADR using @ADR({num}) as annotation.

When adding a new Localization.lang entry

Add new Localization.lang("KEY") to a Java file. The tests will fail. In the test output a snippet is generated, which must be added to the English translation file.

Example:

java.lang.AssertionError: DETECTED LANGUAGE KEYS WHICH ARE NOT IN THE ENGLISH LANGUAGE FILE
PASTE THESE INTO THE ENGLISH LANGUAGE FILE
[
Opens\ JabRef's\ Twitter\ page=Opens JabRef's Twitter page
]
Expected :[]
Actual   :[Opens\ JabRef's\ Twitter\ page (src\main\java\org\jabref\gui\JabRefFrame.java LANG)]

Add the above snippet to the English translation file located at src/main/resources/l10n/JabRef_en.properties. Crowdin will automatically pick up the new string and add it to the other translations.

You can also directly run the specific test in your IDE. The test "LocalizationConsistencyTest" is placed under src/test/java/org.jabref.logic.l10n/LocalizationConsistencyTest.java. Find more information in the JabRef developer docs.

Format of keyboard shortcuts

In Markdown files (e.g., CHANGELOG.md), sometimes keyboard shortcuts need to be added. Example: <kbd>Ctrl</kbd> + <kbd>Enter</kbd>

In case you add keys to the changelog, please follow these rules:

  • <kbd> tag for each key
  • First letter of key capitalized
  • Combined keys separated by +
  • Spaces before and after separator +