diff --git a/.github/workflows/add-greeting-to-issue.yml b/.github/workflows/add-greeting-to-issue.yml index b94650f1a62..e03ca9f8ba6 100644 --- a/.github/workflows/add-greeting-to-issue.yml +++ b/.github/workflows/add-greeting-to-issue.yml @@ -24,6 +24,8 @@ jobs: Newcomers, we're excited to have you on board. Start by exploring our [Contributing](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md) guidelines, and don't forget to check out our [workspace setup guidelines](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace) to get started smoothly. + In case you encounter failing tests during development, please check our [developer FAQs](https://devdocs.jabref.org/code-howtos/faq.html)! + Having any questions or issues? Feel free to ask here on GitHub. Need help setting up your local workspace? Join the conversation on [JabRef's Gitter chat](https://gitter.im/JabRef/jabref). And don't hesitate to open a (draft) pull request early on to show the direction it is heading towards. This way, you will receive valuable feedback. Happy coding! 🚀 diff --git a/docs/code-howtos/faq.md b/docs/code-howtos/faq.md index 368ffc96103..b0dd8db29b5 100644 --- a/docs/code-howtos/faq.md +++ b/docs/code-howtos/faq.md @@ -19,7 +19,7 @@ Following is a list of common errors encountered by developers which lead to fai Read more about the background and format of localization in JabRef [here](https://devdocs.jabref.org/code-howtos/localization.html). * `org.jabref.logic.l10n.LocalizationConsistencyTest` `findObsoleteLocalizationKeys` FAILED - * Fix: There are localization keys [localization properties file](https://github.com/JabRef/jabref/blob/main/src/main/resources/l10n/JabRef_en.properties) that are not used in the code, probably due to the removal of existing code. Navigate to the unused key-value pairs in the file and remove them. You can always click on the details of the failing test to pinpoint which keys are unused. + * Fix: There are localization keys in the [localization properties file](https://github.com/JabRef/jabref/blob/main/src/main/resources/l10n/JabRef_en.properties) that are not used in the code, probably due to the removal of existing code. Navigate to the unused key-value pairs in the file and remove them. You can always click on the details of the failing test to pinpoint which keys are unused. Read more about the background and format of localization in JabRef [here](https://devdocs.jabref.org/code-howtos/localization.html). * `org.jabref.logic.citationstyle.CitationStyle` `discoverCitationStyles` ERROR: Could not find any citation style. Tried with /ieee.csl. diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md index d8095ebd362..b818be103d7 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md @@ -43,7 +43,8 @@ Press Alt+0 to open the commit dialog. Unfortunately, IntelliJ has no support for ignored sub modules [[IDEA-285237](https://youtrack.jetbrains.com/issue/IDEA-285237/ignored-changes-in-submodules-are-still-visible-in-the-commit-window)]. Fortunately, there is a workaround: -Go to **File > Settings... > Version Control > Directory Mappings**. +Go to **File > Settings... > Version Control > Directory Mappings**.
+**Note:** In some MacBooks, `Settings` can be found at the "IntelliJ" button of the app menu instead of at "File". Currently, it looks as follows: @@ -60,3 +61,5 @@ This will make these directories "Unregistered roots:", which is fine. {% figure caption:"Directory Mappings having three unregistered roots" %} ![Directory Mappings having three repositories unregsitered](intellij-directory-mappings-unregistered-roots.png) {% endfigure %} + + diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.md index 2026d64c8fe..a821231b1c7 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.md @@ -8,7 +8,8 @@ nav_order: 12 ## Ensure that JDK 21 is available to IntelliJ -Ensure you have a Java 21 SDK configured by navigating to **File > Project Structure... > Platform Settings > SDKs**. +Ensure you have a Java 21 SDK configured by navigating to **File > Project Structure... > Platform Settings > SDKs**.
+**Note:** In some MacBooks, `Project Structure` can be found at the "IntelliJ" button of the app menu instead of at "File". {% figure caption:"JDKs 11, 14, and 15 shown in available SDKs. JDK 21 is missing." %} ![Plattform Settings - SDKs](intellij-choose-jdk-adoptopenjdk-on-windows-project-settings.png) @@ -193,3 +194,5 @@ A right-click on "BibEntryTests" enables the debugger to start. {% figure caption:"Run window for the BibEntry test case" %} ![Run window for the BibEntry test case](guidelines-intellij-tests-are-green.png) {% endfigure %} + + diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.md index 56f2554e97b..622ab550b5e 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.md @@ -12,7 +12,8 @@ Install the [CheckStyle-IDEA plugin](http://plugins.jetbrains.com/plugin/1065?pr Navigate to **File > Settings... > Plugins"**. On the top, click on "Marketplace". Then, search for "Checkstyle". -Click on "Install" choose "CheckStyle-IDEA". +Click on "Install" choose "CheckStyle-IDEA".
+**Note:** In some MacBooks, `Settings` can be found at the "IntelliJ" button of the app menu instead of at "File". {% figure caption:"Install CheckStyle" %} ![Install CheckStyle](guidelines-intellij-install-checkstyle.png) @@ -159,3 +160,5 @@ Press "OK". > Finally, you have Checkstyle running locally so that you can check for styling errors before submitting the pull request. Got it running? GREAT! You are ready to lurk the code and contribute to JabRef. Please make sure to also read our [contribution guide](https://devdocs.jabref.org/contributing#contribute-code). + +