Contribution Guide

This is the contribution guide for developers wanting to help out with Stoat.

Repository Lifecycle

Making Commits

• Sign-off your commits (Git flag), read here about DCO obligations.
• Sign commits where possible, learn more about that here.
• Prefer to use Conventional Commit style.
• If present, e.g. prettier, cargo fmt, use the formatter.
• Try to keep each PR bound to a single feature or change, multiple bug fixes may be fine in some cases. This is to avoid your PR getting stuck due to parts of it having conflicts or other issues.

Merging Pull Requests

All PR titles must use use Conventional Commit style and will be squash merged!

What can I help with?

Stuff is currently being moved around, for the mean time, come ask in the development server: https://stt.gg/API

Also typically help wanted labels are available on repo issues!

Project Guidance

Please read the additional relevant guidance on:

• Developing for Backend (contrib guide TBA)
• Contributing to Frontend
• Contributing to Android