Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save eliasnogueira/08336ffa3cb19f8c7b21f9ca8e785ba4 to your computer and use it in GitHub Desktop.
Save eliasnogueira/08336ffa3cb19f8c7b21f9ca8e785ba4 to your computer and use it in GitHub Desktop.
Good testing practices in an open-source project

Title

Good testing practices in an open-source project

Description

Nowadays the contribution guide in every open-source project is not sufficient 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 to better understand the documentation, how they can contribute, and the process for it. You will learn about:

Changelog: how it’s important to maintain to tell others about the important changes made in the project, also maintaining 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 both 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’re a lot of excellent open-source tools to help to create better tests, along with specific practices. You will learn about PiTest, TestContainers, AssertJ, and JUnit 5.

Elevator pitch

Open-source projects can be a place where contributors can start learning about the project or elevate their tech skills and knowledge, but how we can 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).

Takeaways

  • Better onboarding contributors by applying a set of testing practices
  • Add more clear vision into the project, like the changelog, breaking change, and testing guide
  • Modernize the testing tooling using the best open-source testing tools
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment