Skip to content

Commit fc46a66

Browse files
authored
Re-commit faq without submodules (#11456)
1 parent d3cb4f0 commit fc46a66

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/code-howtos/faq.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
parent: Code Howtos
3+
---
4+
# Frequently Asked Questions (FAQ)
5+
6+
## Resolving common development errors
7+
8+
Following is a list of common errors encountered by developers which lead to failing tests, with their common solutions:
9+
10+
* `org.jabref.architecture.MainArchitectureTest` `restrictStandardStreams` <span style="color:red">FAILED</span>
11+
* <span style="color:green">Fix</span> : Check if you've used ```System.out.println(...)``` (the standard output stream) to log anything into the console. This is an architectural violation, as you should use the Logger instead for logging. More details on how to log can be found [here](https://devdocs.jabref.org/code-howtos/logging.html).
12+
13+
* `org.jabref.architecture.MainArchitectureTest` `doNotUseLogicInModel` <span style="color:red">FAILED</span>
14+
* <span style="color:green">Fix</span> : One common case when this test fails is when you put any class purely containing business logic at some level inside the ```model``` directory (```org/jabref/model/```). To fix this, shift the class to a subdirectory within the ```logic``` directory (```org/jabref/logic/```).
15+
16+
* `org.jabref.logic.l10n.LocalizationConsistencyTest` `findMissingLocalizationKeys` <span style="color:red">FAILED</span>
17+
* <span style="color:green">Fix</span> : You have probably used Strings that are visible on the UI (to the user) but not wrapped them using ```Localization.lang(...)``` and added them to the [localization properties file](https://github.com/JabRef/jabref/blob/main/src/main/resources/l10n/JabRef_en.properties).
18+
Read more about the background and format of localization in JabRef [here](https://devdocs.jabref.org/code-howtos/localization.html).
19+
20+
<!-- markdownlint-disable-file MD033 -->

0 commit comments

Comments
 (0)