CONTRIBUTING.md

Contributing

The Rivet repository is a monorepo. Each component has its own README.md including information on how to develop it.

Development Quickstart

• Rivet Cluster
• CLI
• Actor SDK
• Site & Docs
• Hub
• Examples

Justfile

It's recommended to use just to run development commands, though not required.

Nix Environment

It's recommended to install the Nix package manager in order to build a consistent environment.

Once installed, run nix-shell to build your development environment.

Conventions

• Naming conventions.
• Internal <-> External Aliases.

Making Changes

For Open Source Contributors

1. Fork and Clone: Fork the repository and clone it locally.
2. Branch: Create a feature or bugfix branch.
3. Pull Request:
   • Provide a clear title and description. The title must follow Conventional Commits. These are used for generating our changelogs with Release Please.
   • Link the related GitHub issue (if applicable).
   • Validate that required checks pass. We ensure that Rivet's required checks run within < 5 minutes.

For Rivet Employees

1. Branching and Commits:
   • Use Graphite for creating and managing branches.
   • Follow the Conventional Commits specification when creating branches.
2. Pull Request:
   • Push your branch to the repo and request a review through Graphite.
   • Link related Linear issues in your PR body using the "magic words" Fixes XXX-123. More information.
     • Manually mark your issue as Ready to Merge when ready.
   • Validate that required checks pass. We ensure that required checks run within reasonable time.
3. Merging:
   • Once approved, it's up to you to merge your commit. If deploying the frontend, make sure to monitor the changes from Sentry before going offline.
   • Manually mark your issue as Complete once finished.

Release

# Release latest
just release-latest VERSION

# Release no latest (including rc)
just release-nolatest VERSION