Arie van Deursen, Maurício Aniche, Valentine Mairet and Sander van den Oever.
Delft University of Technology, The Netherlands, April 17, 2017, Version 1.0
We are proud to present Delft Students on Software Architecture, a collection of 27 architectural descriptions of open source software systems written by students from Delft University of Technology during a master-level course taking place in the spring of 2017.
In this course, teams of 3-4 students could adopt a project of choice on GitHub. The projects selected had to be sufficiently complex and actively maintained (one or more pull requests merged per day). The systems are from a wide range of domains, including testing frameworks (Mockito, JUnit5), editors (Neovim, VSCode), music (Beets), and visualisation (Kibana).
During a 8-week period, the students spent one third of their time on this course, and engaged with these systems in order to understand and describe their software architecture.
Inspired by Brown and Wilsons' Architecture of Open Source Applications, we decided to organize each description as a chapter, resulting in the present online book.
This book is the third in volume the DESOSA series: The first DESOSA book resulted from the 2015 edition of the course, and contained architectural descriptions of ten (different) open source systems. The [second DESOSA book] followed a year later, including 21 architectural descriptions.
The chapters share several common themes, which are based on smaller assignments the students conducted as part of the course. These themes cover different architectural 'theories' as available on the web or in textbooks. The course used Rozanski and Woods' Software Systems Architecture, and therefore several of their architectural viewpoints and perspectives recur.
The first theme is outward looking, focusing on the use of the system. Thus, many of the chapters contain an explicit stakeholder analysis, as well as a description of the context in which the systems operate. These were based on available online documentation, as well as on an analysis of open and recently closed issues for these systems.
A second theme involves the development viewpoint, covering modules, layers, components, and their inter-dependencies. Furthermore, it addresses integration and testing processes used for the system under analysis.
A third recurring theme is technical debt. Large and long existing projects are commonly vulnerable to debt. The students assessed the current debt in the systems and provided proposals on resolving this debt where possible.
TODO: Write this section. Collect all PRs and write a nice summary.
TODO: Link to collaborative chapter when we are adding this.
Last but not least, the chapters are also based on the student's experience in actually contributing to the systems described. As part of the course over 75 pull requests to the projects under study were made, including refactorings (Ember 13088, Rails 24198), bug fixes (Terasology 2235), new features (Karma 1983), test cases (Sonic-Pi 1054), translations (OpenTripPlanner 2232), and documentation (OpenCV 4375). Many projects had issues explicitly marked as "good for new contributors", making it easier for students to find a good starting point.
Through these contributions the students often interacted with lead developers and architects of the systems under study, gaining first-hand experience with the architectural trade-offs made in these systems.
While we worked hard on the chapters to the best of our abilities, there might always be omissions and inaccuracies. We value your feedback on any of the material in the book. For your feedback, you can:
- Open an issue on our GitHub repository for this book.
- Offer an improvement to a chapter by posting a pull request on our GitHub repository.
- Contact @delftswa on Twitter.
- Send an email to Arie.vanDeursen at tudelft.nl.
We would like to thank:
- Our guest speakers: Nicolas Dintzner, Maikel Lobbezoo, Ali Niknam, Alex Nederlof, Felienne Hermans, Marcel Bakker and Marc Philipp.
- Valentine Mairet who created the front cover of this book.
- Michael de Jong and Alex Nederlof who were instrumental in the earlier editions of this course.
- All open source developers who helpfully responded to the students' questions and contributions.
- The excellent gitbook toolset and gitbook hosting service making it easy to publish a collaborative book like this.
- Arie van Deursen, Alex Nederlof, and Eric Bouwers. Teaching Software Architecture: with GitHub! avandeursen.com, December 2013.
- Nick Rozanski and Eoin Woods. Software Systems Architecture: Working with Stakeholders Using Viewpoints and Perspectives. Addison-Wesley, 2012, 2nd edition.
- Sven Apel, Don Batory, Christian Kästner, Gunter Saake. Feature-Oriented Software Product Lines: Concepts and Implementation. Springer-Verlag, 2013.
- Eric Bouwers. Metric-based Evaluation of Implemented Software Architectures. PhD Thesis, Delft University of Technology, 2013.
- Amy Brown and Greg Wilson (editors). The Architecture of Open Source Applications. Volumes 1-2, 2012.
- Arie van Deursen and Rogier Slag (editors). Delft Students on Software Architecture: DESOSA 2015. delftswa.github.io, 2015.
The copyright of the chapters is with the authors of the chapters. All chapters are licensed under the Creative Commons Attribution 4.0 International License. Reuse of the material is permitted, provided adequate attribution (such as a link to the corresponding chapter on the DESOSA book site) is included.
Cover image credits: TU Delft library, TheSpeedX at Wikimedia; Owl on Emojipedia Sample Image Collection at Emojipedia; Feathers by Franco Averta at Flaticon.
