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.
Commit using Conventional Commit style.
Use prettier in relevant repositories using Typescript, use cargo fmt in those using Rust. Note: PRs should only format files that have been changed to avoid conflicts.
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

To keep commit history nice and tidy, always use Conventional Commit style for any merge commit messages. And where possible:

Squash and Merge for bug fixes / small features, especially if the fix has multiple iterations, example, or if the commits don't follow conventional commit style.

Beyond this point you should usually check with a maintainer on how to merge, and should only proceed with the following if the commits follow Conventional Commit style:

Prefer to Rebase and Merge where possible.
Create a merge request with commit message similar to merge: remote-tracking branch abc into xyz (#1).

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