From 724ac9be356836c60eeede8b9c379ee745d81c4c Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 21 Feb 2020 22:46:04 +0000 Subject: [PATCH] Add initial section on code quality --- docs/code-quality.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/code-quality.md diff --git a/docs/code-quality.md b/docs/code-quality.md new file mode 100644 index 00000000000..fd46c7a9b93 --- /dev/null +++ b/docs/code-quality.md @@ -0,0 +1,12 @@ +# Code Quality + +We monitor the general source code quality at three places: + +* [Teamscale](https://www.cqse.eu/de/produkte/teamscale/landing/) is a popular German product analyzing code quality. The analysis results are available at . +* [codacy](https://www.codacy.com/) is a hosted service to monitor code quality. The code quality analysis for JabRef is available at . +* [codecov](https://codecov.io/) is a solution to check code coverage of test cases. The code coverage metrics for JabRef are available at . + +We strongly recommend to read following two books on code quality: + +* [Java by Comparison](java.by-comparison.com/) is a book by three JabRef developers which focuses on code improvements close to single statements. It is fast to read and one gains much information from each recommendation discussed in the book. +* [Effective Java](https://www.oreilly.com/library/view/effective-java-3rd/9780134686097/) is the standard book for advanced Java programming. Did you know that `enum` is the [recommended way to enforce a singleton instance of a class](https://learning.oreilly.com/library/view/effective-java-3rd/9780134686097/ch2.xhtml#lev3)? Did you know that one should [refer to objects by their interfaces](https://learning.oreilly.com/library/view/effective-java-3rd/9780134686097/ch9.xhtml#lev64)?