JabRef and Software Engineering

With JabRef students can level-up their coding and GitHub skills. When taking part in JabRef development, one will learn modern Java coding practices, how code reviews work and how to properly address reviewing feedback.

JabRef tries to achieve high code quality. This ultimately leads to improved software engineering knowledge of contributors. After contributing for JabRef, both coding and general software engienering skills will have increased. Our development strategy provides more details.

We recommend to start early and constantly, since students wirking earlier and more often, produce projects that are more correct, completed earlier at the same overall invested time 1.

Notes for instructors

  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 for more details.

  4. Choose tasks from one of the following boards. Write a comment on each issue so that it can be reserved for your course.

  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

  6. Get in touch with the JabRef team to discuss details. We offer email, skype, gitter.im, discord. Get in touch with @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 for appropriate tasks (and fill it as needed), e) recommend appropriate features.

It is also possible to just direct students to our Contribution 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.

Since a huge fraction of software costs is spend on software maintenance, adding new features also educates in that aspect: perfective maintenance1 is trained. When fixing bugs, corrective maintenance2 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.

The process for accepting contributions is as below. The syntax is BPMN modeled using bpmn.io.

process

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

GitHub describes that in their page Unterstanding the GitHub flow:

GitHub flow

Process for Java newcomers

Newcomers contributing in the context of a university teaching experience are invited to follow the process described above. In case the capacity of the instructing university allows, we propose a three-step approach. First, the contributors prepare their contribution as usual. Then, they submit the pull request to a separate repository. There, the instructor reviews the pull request and provides feedback. This happens in a loop until the instructor shows the green light. Then, the pull request can be submitted to the main JabRef repository. This will help to reduce the load on the JabRef team and improve the quality of the initial pull request.

process with instructor

Past courses

In case your course is missing, feel free to add it.

English

Harbin Institute of Technology (HIT), China

Course: Open Source Software Development

  • 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.

  • Course offered in 2018 and 2019. Examples of merged pull requests: 4217, 4255, 4227, 4260, 5150

Northern Arizona University (NAU), USA

Course CS499 - Open Source Software Development

  • Summary: Students experience the process of getting involved in an Open Source project by engaging with a real project. Their goal is to make a "substantial" contribution to a project.

  • Course offered in 2018

German

Universität Basel, Switzerland

Course 10915-01: Software Engineering

  • Successfully run Q3 2019.

  • Excercise touching JabRef:

    • General idea: identify a feature missing in JabRef and develop the specification, system design, and implementation of the feature.

    • Introduction to JabRef's code: Exercise 5: Introduction into JabRef code.

    • Prominent feature implemented: Parse full-text references using Grobid. PR #5614.

University of Stuttgart, Germany

Course "Softwarepraktikum" as part of the BSc Informatik

  • Summary: A group of three students experienced the full software engineering process within one semester. They worked part-time for the project.

  • Successfully run in 2012

Course Studienprojekt as part of the BSc Software Engineering

  • Summary: A group of nine students experienced the full software engineering process within one year. They worked part-time for the project.

  • Successfully run in 2015/2016

Course "Programming and Software Development" as part of the BSc Software Engineering

  • Summary: One exercise to contribute a minor fix or feature to JabRef. Goal: learn contribution to an open-source project using git and GitHub.

  • Successfully run in 2018

Swedish

KTH Royal Institute of Technology, Sweden

Course DD2480 Software Engineering Fundamentals

  • 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.

  • Successfully run in 2020

Portuguese

Federal University of Technology, Paraná, Brazil

Course Open Source Software

  • 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.

  • Course offered from 2013 to 2016 with different names

References

1: @ayaankazerouni: Developing Procrastination Feedback for Student Software Developers 2: Lientz B., Swanson E., 1980: Software Maintenance Management. Addison Wesley, Reading, MA.