Open Source

Open Source is a statement for the future: we believe in the ecosystem, and we believe that anyone should continue our projects, should we give them up.

In this section, we showcase our vision, and teach you how to contribute to the Open Source ecosystem yourself.

• The Playgrounds are ready-to-use self-updating project templates with documentation, CI/CD… • Learn more
• Stability guarantees followed by our projects • How we avoid breaking your work
• Open Source is based on licenses • See which ones we approve

Contributing to open source projects

Many people are interested to contributing to the open source ecosystem, but do not know where to start: what are forks, merge requests, what happens during a review? We wrote a guide to contribution:

1. What are forks, and why do we use them?
2. How do I submit changes?
3. What goes on during code review?

Each project is different, and each maintainer expects different things. Project-specific instructions are often described in a file named CONTRIBUTING.md. These articles describe the most common practices as well as our own conventions.

Guides and tutorials

This section explains how to perform specific actions to configure your own environment. These articles are not necessary in the general case, but we found that they are a common source of difficulty for our contributors.

• Self-hosting a GitLab runner
• Configuring a GitLab project

Conventions

To be able to develop as many projects as we do, we must structure the way we work such that it is easy to integrate work from different people. We therefore have created different conventions that describe how we prefer to do things.

These conventions are inspired by many popular similar options, so they should be familiar to most developers.

• OpenSavvy Flow
• OpenSavvy Commit Style
• OpenSavvy Code Style