Skip to content

Commit 5cc71c0

Browse files
committed
Merge remote-tracking branch 'upstream/master' into fixEditionTest
* upstream/master: Bump jython-standalone from 2.7.1 to 2.7.2 (#6209) Bump org.beryx.jlink from 2.17.3 to 2.17.4 (#6214) Bump checkstyle from 8.30 to 8.31 (#6215) Fix typos and grammar mistakes in teaching.md (#6216) Delete tests-oracle.yml (#6217)
2 parents 7eef9cd + 7a4e025 commit 5cc71c0

File tree

3 files changed

+23
-117
lines changed

3 files changed

+23
-117
lines changed

.github/workflows/tests-oracle.yml

-89
This file was deleted.

build.gradle

+3-8
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ plugins {
2222
id 'com.github.ben-manes.versions' version '0.28.0'
2323
id 'org.javamodularity.moduleplugin' version '1.5.0'
2424
id 'org.openjfx.javafxplugin' version '0.0.8'
25-
id 'org.beryx.jlink' version '2.17.3'
25+
id 'org.beryx.jlink' version '2.17.4'
2626

2727
// nicer test outputs during running and completion
2828
id 'com.adarshr.test-logger' version '2.0.0'
@@ -212,9 +212,9 @@ dependencies {
212212
testImplementation "org.testfx:testfx-junit5:4.0.17-alpha-SNAPSHOT"
213213
testImplementation "org.hamcrest:hamcrest-library:2.2"
214214

215-
checkstyle 'com.puppycrawl.tools:checkstyle:8.30'
215+
checkstyle 'com.puppycrawl.tools:checkstyle:8.31'
216216
xjc group: 'org.glassfish.jaxb', name: 'jaxb-xjc', version: '2.3.2'
217-
jython 'org.python:jython-standalone:2.7.1'
217+
jython 'org.python:jython-standalone:2.7.2'
218218
}
219219

220220
dependencyUpdates {
@@ -232,11 +232,6 @@ dependencyUpdates.resolutionStrategy = {
232232
selection.reject('Release candidate')
233233
}
234234
}
235-
rules.withModule("org.python:jython-standalone") { ComponentSelection selection ->
236-
if (selection.candidate.version ==~ /2.7.2b\d/ || selection.candidate.version ==~ /2.7.2rc\d/) {
237-
selection.reject('Release candidate')
238-
}
239-
}
240235
rules.withModule("de.jensd:fontawesomefx-materialdesignfont") { ComponentSelection selection ->
241236
if (selection.candidate.version ==~ /2.0.26.*/) {
242237
selection.reject('1.7.22-11 is actually newer (strange version system)')

docs/teaching.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# JabRef as Basis for Teaching Material
22

3-
JabRef can be used as training object for software engineering.
3+
JabRef can be used as a training object for software engineering.
44

5-
As instructor, please follow this check list:
5+
As an instructor, please follow this checklist:
66

77
1. Be aware that JabRef is run by volunteers. This implies that the development team cannot ensure to provide feedback on code within hours.
88
2. Be aware that from the first pull request to the final acceptance the typical time needed is two weeks.
99
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.
10-
4. Choose tasks from one of the folowing boards. Write a comment to each issue so that it can be reserved to your course.
10+
4. Choose tasks from one of the following boards. Write a comment on each issue so that it can be reserved for your course.
1111
- Feature Board: <https://github.com/JabRef/jabref/projects/7>
1212
- Bug Board: <https://github.com/JabRef/jabref/projects/5>
13-
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
14-
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.
13+
5. Be aware that the difficulty 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
14+
6. Get in touch with the JabRef team to discuss details. We offer email, skype, [gitter.im](https://gitter.im/JabRef/jabref), discord. Get in touch with [@koppor](https://github.com/koppor/) to find the right channel and to start forming the success of your course.
1515

1616
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.
1717

18-
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.
18+
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 the time of the students has to be spent to a) learn about JabRef and b) select an appropriate issue.
1919

2020
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<sup id="a1">[1](#LientzSwanson)</sup> is trained. When fixing bugs, corrective maintenance<sup>[1](#LientzSwanson)</sup> is trained.
2121

@@ -29,17 +29,17 @@ The syntax is [BPMN](https://en.wikipedia.org/wiki/Business_Process_Model_and_No
2929
[![process](images/contribution-process-reviews.svg)](images/contribution-process-reviews.svg)
3030

3131
In short, the contribution is **reviewed by two JabRef developers**.
32-
Typically, they have constructive feedback on the contribution.
33-
This means, that the contributors get comments on their contriubiton enabling them to level-up their coding skill.
34-
Incorporating the improvments takes time, too.
35-
The benifit is two fold: a) contributors improve their coding skills and b) JabRef's code quality improves.
36-
All in all, we ask to respect the aims of the JabRef team and to reserve time to incorporate the reviewer's comemnts
32+
Typically, they have constructive feedback on their contribution.
33+
This means, that the contributors get comments on their contribution enabling them to level-up their coding skill.
34+
Incorporating improvements takes time, too.
35+
The benefit is two-fold: a) contributors improve their coding skills and b) JabRef's code quality improves.
36+
All in all, we ask to respect the aims of the JabRef team and to reserve time to incorporate the reviewer's comments
3737

3838
## Process for Java newcomers
3939

4040
Newcomers are invited to follow the process described above.
41-
In case the capacity of the instructing university allows, we propose a three step approach.
42-
First the contributors prepare their contribution as usual.
41+
In case the capacity of the instructing university allows, we propose a three-step approach.
42+
First, the contributors prepare their contribution as usual.
4343
Then, they submit the pull request *to a separate repository*.
4444
There, the instructor reviews the pull request and provides feedback.
4545
This happens in a loop until the instructor shows the green light.
@@ -58,7 +58,7 @@ This will help to reduce the load on the JabRef team and improve the quality of
5858

5959
Course: Open Source Software Development
6060

61-
- Summary: In this course, students will be introduced to the processes and tools specific to Open Source Software development, and they will analyze existing projects to understand the architecture and processes of these projects. In addition, students will attempt to contribute source code to a large existing Open Source Software project.
61+
- Summary: In this course, students will be introduced to the processes and tools specific to Open Source Software development, and they will analyze existing projects to understand the architecture and processes of these projects. Besides, students will attempt to contribute source code to a large existing Open Source Software project.
6262
- Course offered in 2018 and 2019. Examples of merged pull requests: [4217](https://github.com/JabRef/jabref/pull/4217), [4255](https://github.com/JabRef/jabref/pull/4255), [4227](https://github.com/JabRef/jabref/pull/4227), [4260](https://github.com/JabRef/jabref/pull/4260), [5150](https://github.com/JabRef/jabref/pull/5150)
6363

6464
#### Northern Arizona University (NAU), USA
@@ -77,9 +77,9 @@ Course [10915-01: Software Engineering](https://dmi.unibas.ch/de/studium/compute
7777
- Lecture Materials: <https://github.com/unibas-marcelluethi/software-engineering>
7878
- Successfully run Q3 2019.
7979
- Excercise touching JabRef:
80-
- General idea: identify a feature missing in JabRef and develop specification, system design, and implementiation of the feature.
80+
- General idea: identify a feature missing in JabRef and develop the specification, system design, and implementation of the feature.
8181
- Introduction to JabRef's code: [Exercise 5](https://github.com/unibas-marcelluethi/software-engineering/blob/master/docs/week5/exercises/practical-exercises.md): Introduction into JabRef code.
82-
- Prominent feature implenented: Parse full text references using Grobid. PR [#5614](https://github.com/JabRef/jabref/pull/5614).
82+
- Prominent feature implemented: Parse full-text references using Grobid. PR [#5614](https://github.com/JabRef/jabref/pull/5614).
8383

8484
#### University of Stuttgart, Germany
8585

@@ -95,8 +95,8 @@ Course [Studienprojekt](https://www.f05.uni-stuttgart.de/informatik/studierende/
9595

9696
Course "Programming and Software Development" as part of the [BSc Software Engineering](https://www.uni-stuttgart.de/en/study/study-programs/Software-Engineering-B.Sc-00001./)
9797

98-
- Summary: One excersice to contribute a minor fix or feature to JabRef. Goal: learn contribution to an open source project using git and GitHub.
99-
- Successfuly run in 2018
98+
- Summary: One exercise to contribute a minor fix or feature to JabRef. Goal: learn contribution to an open-source project using git and GitHub.
99+
- Successfully run in 2018
100100

101101
### Swedish
102102

@@ -105,15 +105,15 @@ Course "Programming and Software Development" as part of the [BSc Software Engin
105105
Course [DD2480 Software Engineering Fundamentals](https://www.kth.se/student/kurser/kurs/DD2480?l=en)
106106

107107
- 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.
108-
- Successfuly run in 2020
108+
- Successfully run in 2020
109109

110110
### Portuguese
111111

112112
#### Federal University of Technology, Paraná, Brazil
113113

114114
Course [Open Source Software](https://github.com/igorsteinmacher/DSL-UTFPR)
115115

116-
- Summary: Students are requested to contribute to an Open Source project to learn about maintenance and evolution of software projects. This project is the predecessor of NAU's CS499.
116+
- Summary: Students are requested to contribute to an Open Source project to learn about the maintenance and evolution of software projects. This project is the predecessor of NAU's CS499.
117117
- Course offered from 2013 to 2016 with different names
118118

119119
## References

0 commit comments

Comments
 (0)