Skip to content

Contribute

Where the repositories are, what makes a change easy to take, how to report a problem, and the terms a contribution arrives under.

The framework already built

Trebired builds its web applications on a framework of its own: the frontend, the bundler, the logger, the store and the packages around them. All of it is public at github.com/Trebired under MIT or the AGPL, so building with it starts from working code. There is no contributor portal, no application, and nothing to be granted access to. Pick the repository the problem lives in, read its README and its changelog, and open an issue or a pull request.

What makes a change easy to take

  1. One change per commit

    One coherent change, so it can be read, reverted and released on its own.

  2. Described by behaviour, not files

    Say what changed for the person using it, not which files moved.

  3. Passes the discipline gate

    The discipline tool that gates our own commits runs on yours. A change that fails it is not merged.

  4. A reason for every new dependency

    Only when the code cannot be written instead. Most of the time it can.

Reporting is worth as much as patching

An issue that reproduces a bug exactly is worth more than a fix that guesses at the cause. Say what you did, what happened, and what you expected, with the version you were on.

A security problem does not go in an issue. It goes through the security page, which exists so that a vulnerability is not public before there is something to upgrade to.

What arrives, and on what terms

Arrives

Your patch, under its licence

A contribution arrives under the licence of the repository it is sent to. That is the whole agreement; there is no separate contributor licence to sign.

Owed back

Nothing

In return the organization owes nothing. Not a merge, not credit, not a response, not payment. A patch can sit, be rewritten, or be refused without an explanation. We would rather say that here than let anyone discover it after spending a weekend on something.