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