Skip to content

COLLABORATING.md

Latest commit

 

History

History
43 lines (37 loc) · 3 KB

COLLABORATING.md

File metadata and controls

43 lines (37 loc) · 3 KB

On how to work together

  • we do trunk-based development with a twist
    • Long lasting feature branches are discouraged, and instead small commits to main are preferred.
    • use preferably short-lived PRs when…
      • …you potentially want feedback on changes
      • …changes would break known downstream users, to allow those who are affected to influence the outcome towards greater value.
    • use issues for analysis and discussion of features and to track PRs…
      • …if collaboration on a feature and prior feedback is desired
    • feel free to use the project-board to organize your issues, PRs or cards
  • main must never be broken or show warnings
    • An easy way to achieve this is to run just test check-size before pushing or just check-size && git push.
    • If you're unsure about remembering to do this, we suggest using a pre-commit git hook.
  • if main breaks on CI which can happen nonetheless…
    • …and you do know the cause, please fix it immediately. If necessary by reverting the offending commit until a more durable fix is possible.
    • …and you do not know the cause, please open a PR to invite collaborators for their input. This is to avoid multiple collaborators trying to fix the issue independently, causing merge-conflicts and confusion. We use this PR as synchronization primitive.
  • please disclose AI assistance when collaborating
    • if AI edits files for you, disclose it in the PR description and commit metadata, preferably with an AI author such as $agent $version <ai-agent@example.invalid> or a Co-authored-by: <agent-identity> trailer.
    • agents operating through a person's GitHub account must identify themselves in comments, for example with phrases like AI agent on behalf of <person>: ....
    • fully AI-generated PR or issue comments must be disclosed. Undisclosed AI-generated comments may lead to the PR or issue being closed.
    • AI-assisted proofreading or wording polish does not need disclosure, but it is still courteous to mention it when the AI materially influenced the final text.
  • for crates you own
    • feel free to make any kind of changes to it, including major ones.
    • please use cargo smart-release for publishing to crates.io as it will handle dependencies properly.
  • for crates you do not own
    • for major or architectural changes please open a [discussion], an issue or a PR to allow participation and don't merge until there is agreement.
    • for minor code changes, if they are minor, feel free to make any kind of change you need.

The workflow can be changed after public discussion - to get started, open a PR.

Please see the development guide for more detailed information on how code and cargo manifests are structured.