Good testing practices in an open-source project

By Elias Nogueira

Elevator Pitch

Open-source projects can be where contributors can start learning about the project or elevate their tech skills and knowledge, but how can we make it easy to understand? We have a set of practices and approaches to help you to modernize your project (not only the open-source ones).

Description

Nowadays, more than the contribution guide in every open-source project is required to describe the approaches, techniques, and how people solve break changes.

We all know: they are the most democratic projects we can work on, but sometimes not follow basic practices to elevate the project quality. This talk will show you how to help the projects and the contributors better understand the documentation, how they can contribute, and the process. You will learn about the following:

  • Changelog: how it’s essential to maintain to tell others about the significant changes made in the project, also keeping it following the SemVer approach. Breaking changes: it will show the breaking changes made in the project and how to solve them, hardly connected to Changelog and SemVer.
  • Testing guide: approaches, ways of test creation, patterns, and tools in use will be placed on this guide to help the contributors to write better tests, extending the coverage and keeping the project’s quality level.
  • Toos Modernization: there are many excellent open-source tools to help create better tests, along with specific practices. You will learn about PiTest, TestContainers, AssertJ, and JUnit 5.

Notes

The mentioned practices are being applied in the Eclipse JNoSQL and Jakarta EE Data projects.