From 5de0739048296e7d3dc26aba416a253e92aefd76 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 23 Mar 2020 10:29:02 +0100 Subject: [PATCH 01/13] Replace donation link to directly point to PayPal --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c57b15a927..21ab436819e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Deployment Status](https://github.com/JabRef/jabref/workflows/Deployment/badge.svg)](https://github.com/JabRef/jabref/actions?query=workflow%3ADeployment) [![Build Status](https://github.com/JabRef/jabref/workflows/Tests/badge.svg)](https://github.com/JabRef/jabref/actions?query=workflow%3ATests) [![codecov.io](https://codecov.io/github/JabRef/jabref/coverage.svg?branch=master)](https://codecov.io/github/JabRef/jabref?branch=master) -[![Donation](https://img.shields.io/badge/donate%20to-jabref-orange.svg)](https://donations.jabref.org) +[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square)](https://paypal.me/JabRef) [![Crowdin](https://d322cqt584bo4o.cloudfront.net/jabref/localized.svg)](https://crowdin.com/project/jabref) JabRef is an open-source, cross-platform citation and reference management tool. From a9d68b506d98e1c58e2921df62a8c4b53d826025 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 23 Mar 2020 10:34:27 +0100 Subject: [PATCH 02/13] Refine teaching information --- docs/teaching.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/teaching.md b/docs/teaching.md index 6df30075b2f..93cc022a115 100644 --- a/docs/teaching.md +++ b/docs/teaching.md @@ -2,19 +2,21 @@ JabRef can be used as training object for software engineering. -As instructor, please follow following check list: +As instructor, please follow this check list: 1. Be aware that JabRef is run by volunteers. This implies that the development team cannot ensure to provide feedback on code within hours. 2. Be aware that from the first pull request to the final acceptance the typical time needed is two weeks. 3. Be aware that JabRef tries to achieve high code quality. This leads to code reviews requiring actions from the contributors. This also applies for code of students. Read on at our [Development Strategy](development-strategy.md) for more details. 4. Choose tasks from one of the folowing boards. Write a comment to each issue so that it can be reserved to your course. - - Feature Board: - Bug Board: - 5. Be aware that the difficuly of bugs and feature vary. A task should be chosen with care. The JabRef team can help here: The majority of the team has experiences in teaching 6. Get in touch with the JabRef team to discuss details. We offer email, skype, [gitter.im](https://gitter.im/JabRef/jabref), discort. Get in touch with [@koppor](https://github.com/koppor/) to find the right channel and to start forming the success of your course. +For a near-to-perfect preparation and effect of the course, we ask you to get in touch with us **four weeks** in advance. Then, the JabRef team can a) learn about the starting skill level of the students, b) the aimed skill level at the end of the course, c) the amount of time the students are given to learn about and contribute to JabRef, d) check the [feature board](https://github.com/JabRef/jabref/projects/7) for appropriate tasks (and fill it as needed), e) recommend appropriate features. + +It is also possible to just direct students to our [Contribution Guide](https://github.com/JabRef/jabref/blob/master/CONTRIBUTING.md#contributing-guide). The learning effect may be lower as time of the students has to be spend to a) learn about JabRef and b) select an appropriate issue. + ## Process for contributions There is no special process for student contributions. We want to discuss it nevertheless to increase awareness of the time required from starting the contribution until the inclusion in a release of JabRef. From 67daf36705a2f1f79f60e3e5bd58f90d53cd747f Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 23 Mar 2020 10:55:58 +0100 Subject: [PATCH 03/13] Add link to teaching page --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ffd0c8b1590..04679d41fea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,8 @@ After reading through this guide, check out some good first issues to contribute to by clicking here: [Good First Issues](https://github.com/JabRef/jabref/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) +In case you are an instructor and want to use JabRef as software engineering example, please head to . + ## Understanding the basics 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](https://guides.github.com/introduction/flow/index.html) and the explanation of [Feature Branch Workflow](https://atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow) for the idea behind this kind of development. From 7dd5329c5e7f6a7ab682996a06233fc10b6702e8 Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2020 12:43:32 +0100 Subject: [PATCH 04/13] Bump junit-platform-launcher from 1.6.0 to 1.6.1 (#6168) Bumps [junit-platform-launcher](https://github.com/junit-team/junit5) from 1.6.0 to 1.6.1. - [Release notes](https://github.com/junit-team/junit5/releases) - [Commits](https://github.com/junit-team/junit5/commits) Signed-off-by: dependabot-preview[bot] Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index b3f1871f7ec..077099cbe7b 100644 --- a/build.gradle +++ b/build.gradle @@ -199,7 +199,7 @@ dependencies { testImplementation 'io.github.classgraph:classgraph:4.8.65' testImplementation 'org.junit.jupiter:junit-jupiter:5.6.0' testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.6.0' - testImplementation 'org.junit.platform:junit-platform-launcher:1.6.0' + testImplementation 'org.junit.platform:junit-platform-launcher:1.6.1' testImplementation 'net.bytebuddy:byte-buddy-parent:1.10.8' testRuntime group: 'org.apache.logging.log4j', name: 'log4j-core', version: '3.0.0-SNAPSHOT' From 27900d04a0dfc82de7c8cb80ce6338285e8db7e7 Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2020 12:43:46 +0100 Subject: [PATCH 05/13] Bump junit-jupiter from 5.6.0 to 5.6.1 (#6159) Bumps [junit-jupiter](https://github.com/junit-team/junit5) from 5.6.0 to 5.6.1. - [Release notes](https://github.com/junit-team/junit5/releases) - [Commits](https://github.com/junit-team/junit5/compare/r5.6.0...r5.6.1) Signed-off-by: dependabot-preview[bot] Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index 077099cbe7b..2bed22813e7 100644 --- a/build.gradle +++ b/build.gradle @@ -197,7 +197,7 @@ dependencies { testImplementation 'io.github.classgraph:classgraph:4.8.65' - testImplementation 'org.junit.jupiter:junit-jupiter:5.6.0' + testImplementation 'org.junit.jupiter:junit-jupiter:5.6.1' testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.6.0' testImplementation 'org.junit.platform:junit-platform-launcher:1.6.1' From 558e19b1050dc0e1b3bbe7d0cee5b4c06f24f1d1 Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2020 12:44:41 +0100 Subject: [PATCH 06/13] Bump fontbox from 2.0.18 to 2.0.19 (#6167) Bumps fontbox from 2.0.18 to 2.0.19. Signed-off-by: dependabot-preview[bot] Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index 2bed22813e7..e810f88cee2 100644 --- a/build.gradle +++ b/build.gradle @@ -112,7 +112,7 @@ dependencies { implementation fileTree(dir: 'lib', includes: ['*.jar']) implementation 'org.apache.pdfbox:pdfbox:2.0.18' - implementation 'org.apache.pdfbox:fontbox:2.0.18' + implementation 'org.apache.pdfbox:fontbox:2.0.19' implementation 'org.apache.pdfbox:xmpbox:2.0.18' implementation group: 'org.apache.commons', name: 'commons-csv', version: '1.8' From 92227e32a81f3c08c52d99c0a705e19d13785e6f Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2020 12:45:18 +0100 Subject: [PATCH 07/13] Bump mariadb-java-client from 2.5.4 to 2.6.0 (#6160) Bumps [mariadb-java-client](https://github.com/mariadb-corporation/mariadb-connector-j) from 2.5.4 to 2.6.0. - [Release notes](https://github.com/mariadb-corporation/mariadb-connector-j/releases) - [Changelog](https://github.com/mariadb-corporation/mariadb-connector-j/blob/master/CHANGELOG.md) - [Commits](https://github.com/mariadb-corporation/mariadb-connector-j/compare/2.5.4...2.6.0) Signed-off-by: dependabot-preview[bot] Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index e810f88cee2..9c07fb6f99a 100644 --- a/build.gradle +++ b/build.gradle @@ -141,7 +141,7 @@ dependencies { antlr4 'org.antlr:antlr4:4.8-1' implementation 'org.antlr:antlr4-runtime:4.8-1' - implementation group: 'org.mariadb.jdbc', name: 'mariadb-java-client', version: '2.5.4' + implementation group: 'org.mariadb.jdbc', name: 'mariadb-java-client', version: '2.6.0' implementation 'org.postgresql:postgresql:42.2.11' From 2e890542bddee105c7a4c83629c4158fc6c1c353 Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2020 12:45:33 +0100 Subject: [PATCH 08/13] Bump junit-vintage-engine from 5.6.0 to 5.6.1 (#6162) Bumps [junit-vintage-engine](https://github.com/junit-team/junit5) from 5.6.0 to 5.6.1. - [Release notes](https://github.com/junit-team/junit5/releases) - [Commits](https://github.com/junit-team/junit5/compare/r5.6.0...r5.6.1) Signed-off-by: dependabot-preview[bot] Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index 9c07fb6f99a..784d6a3a465 100644 --- a/build.gradle +++ b/build.gradle @@ -198,7 +198,7 @@ dependencies { testImplementation 'io.github.classgraph:classgraph:4.8.65' testImplementation 'org.junit.jupiter:junit-jupiter:5.6.1' - testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.6.0' + testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.6.1' testImplementation 'org.junit.platform:junit-platform-launcher:1.6.1' testImplementation 'net.bytebuddy:byte-buddy-parent:1.10.8' From d6fcf11261862c561ff6a6645fcc3aa5c617a9a3 Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2020 12:46:06 +0100 Subject: [PATCH 09/13] Bump xmpbox from 2.0.18 to 2.0.19 (#6164) Bumps xmpbox from 2.0.18 to 2.0.19. Signed-off-by: dependabot-preview[bot] Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index 784d6a3a465..6f5342a918f 100644 --- a/build.gradle +++ b/build.gradle @@ -113,7 +113,7 @@ dependencies { implementation 'org.apache.pdfbox:pdfbox:2.0.18' implementation 'org.apache.pdfbox:fontbox:2.0.19' - implementation 'org.apache.pdfbox:xmpbox:2.0.18' + implementation 'org.apache.pdfbox:xmpbox:2.0.19' implementation group: 'org.apache.commons', name: 'commons-csv', version: '1.8' From 361d7ce9854b3546713c9c50adc2a5d0e1a147d4 Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2020 12:46:23 +0100 Subject: [PATCH 10/13] Bump pdfbox from 2.0.18 to 2.0.19 (#6163) Bumps pdfbox from 2.0.18 to 2.0.19. Signed-off-by: dependabot-preview[bot] Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index 6f5342a918f..ea34634cebb 100644 --- a/build.gradle +++ b/build.gradle @@ -111,7 +111,7 @@ dependencies { // Include all jar-files in the 'lib' folder as dependencies implementation fileTree(dir: 'lib', includes: ['*.jar']) - implementation 'org.apache.pdfbox:pdfbox:2.0.18' + implementation 'org.apache.pdfbox:pdfbox:2.0.19' implementation 'org.apache.pdfbox:fontbox:2.0.19' implementation 'org.apache.pdfbox:xmpbox:2.0.19' From 98c39bfe06ace037622d3cd3b4ba027e637f24e3 Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2020 12:46:41 +0100 Subject: [PATCH 11/13] Bump unirest-java from 3.6.01 to 3.7.00 (#6166) Bumps [unirest-java](https://github.com/Kong/unirest-java) from 3.6.01 to 3.7.00. - [Release notes](https://github.com/Kong/unirest-java/releases) - [Changelog](https://github.com/Kong/unirest-java/blob/master/CHANGELOG.md) - [Commits](https://github.com/Kong/unirest-java/compare/v3.6.01...v3.7.00) Signed-off-by: dependabot-preview[bot] Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index ea34634cebb..b0953b82aae 100644 --- a/build.gradle +++ b/build.gradle @@ -170,7 +170,7 @@ dependencies { implementation 'org.controlsfx:controlsfx:11.0.1' implementation 'org.jsoup:jsoup:1.13.1' - implementation 'com.konghq:unirest-java:3.6.01' + implementation 'com.konghq:unirest-java:3.7.00' implementation 'org.slf4j:slf4j-api:2.0.0-alpha1' implementation group: 'org.apache.logging.log4j', name: 'log4j-jcl', version: '3.0.0-SNAPSHOT' From 99cb778e70179cd4d73656f86aaac001ed49639e Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 23 Mar 2020 13:22:43 +0100 Subject: [PATCH 12/13] % include doesn't work on GitBook.io. Thus, add explicit text --- docs/contributing.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/contributing.md b/docs/contributing.md index 58dfc7cae1c..daf8b23bbf9 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1 +1,16 @@ -{% include "git+https://github.com/JabRef/jabref.git/CONTRIBUTING.md#master" %} +# Contributing + +See [JabRef's contribution guide](https://github.com/JabRef/jabref/blob/master/CONTRIBUTING.md#contributing-guide) for a howto to contribute code. + +In case you aim for contributing user documentation, head to the [JabRef user documetnation repository](https://github.com/JabRef/user-documentation). + +For improving developer's documentation, go on at the [docs/ subdirectory of JabRef's code](https://github.com/JabRef/jabref/tree/master/docs) and edit the file. +GitHub offers a good guide at [Editing files in another user's repository](https://help.github.com/en/github/managing-files-in-a-repository/editing-files-in-another-users-repository). + +In case you use some gitbook special features and you want to test them, checkout JabRef's code locally, and execute following steps: + +1. `npm install -g gitbook` +2. `cd docs` +3. `gitbook serve` + +Then, you can see a near-to-reality rendering of the development documentation at . From 08b572d273d1a72afedb5a900774773aa8ace4c4 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 23 Mar 2020 13:35:05 +0100 Subject: [PATCH 13/13] Refine teaching explanation --- docs/teaching.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/teaching.md b/docs/teaching.md index 93cc022a115..57138231722 100644 --- a/docs/teaching.md +++ b/docs/teaching.md @@ -17,6 +17,8 @@ For a near-to-perfect preparation and effect of the course, we ask you to get in It is also possible to just direct students to our [Contribution Guide](https://github.com/JabRef/jabref/blob/master/CONTRIBUTING.md#contributing-guide). The learning effect may be lower as time of the students has to be spend to a) learn about JabRef and b) select an appropriate issue. +Since a huge fraction of software costs is spend on [software maintenance](https://en.wikipedia.org/wiki/Software_maintenance), adding new features also educates in that aspect: perfective maintenance[1](#LientzSwanson) is trained. When fixing bugs, corrective maintenance[1](#LientzSwanson) is trained. + ## Process for contributions There is no special process for student contributions. We want to discuss it nevertheless to increase awareness of the time required from starting the contribution until the inclusion in a release of JabRef. @@ -75,3 +77,9 @@ This will help to reduce the load on the JabRef team and improve the quality of - Course [DD2480 Software Engineering Fundamentals](https://www.kth.se/student/kurser/kurs/DD2480?l=en) - Summary: Groups of students from three to five persons experienced the whole software engineering process within a week: From the requirements specification to the final pull request. + +## References + +1: Lientz B., Swanson E., 1980: Software Maintenance Management. Addison Wesley, Reading, MA. + +