ContributingDevelopment setup
Branches and commits
A new feature starts from dev, on its own branch. Each commit message starts with the area that it changes.
Start from a dev branch that is up to date.
1 / 3
Start a branch
New features start from dev. Give the branch the name of the change. Then merge it back into dev.
git switch dev && git pull
git switch -c feat/my-featureWrite the commit message
Start with the area that the commit changes: the crate name, web or docs. Then write a short summary.
ferry-api: SSE change feed, embedded web client, job cancel
web: blue primary color
ferry-engine: fix verified findingsIf the commit has more than one change, list the changes as bullets in the body.
In the same change
| If you change | Also do this |
|---|---|
A CLI command, a ferryd flag, an API route or a DTO | Run npm run generate in docs/ and commit the result. See Generated references. |
| A contract between crates, an API route or a documented behavior | Update DESIGN.md. |