Skip to content

Commit 3f83b73

Browse files
committed
docs: improve monorepo development documentation (#1889)
<!-- Please make sure there is an issue that this PR is correlated to. --> ## Changes <!-- If there are frontend changes, please include screenshots. -->
1 parent df70e3f commit 3f83b73

File tree

6 files changed

+333
-272
lines changed

6 files changed

+333
-272
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,35 @@
11
# Contributing
22

3+
The Rivet repository is a monorepo. Each component has its own README.md
4+
including information on how to develop it.
5+
6+
## Development Quickstart
7+
8+
- [Rivet Cluster](docker/dev-full/README.md)
9+
- [CLI](packages/toolchain/cli/README.md)
10+
- [Actor SDK](sdks/actor/README.md)
11+
- [Site & Docs](site/README.md)
12+
- [Hub](frontend/apps/hub)
13+
- [Examples](examples/README.md)
14+
15+
## Justfile
16+
17+
It's recommended to use [just](https://github.com/casey/just) to run development commands, though not required.
18+
19+
## Nix Environment
20+
21+
It's recommended to install the [Nix package manager](https://nixos.org/download/) in order to build a consistent environment.
22+
23+
Once installed, run `nix-shell` to build your development environment.
24+
325
## Conventions
426

527
- [Naming conventions](./docs-internal/development/NAMING_CONVENTIONS.md).
628
- [Internal <-> External Aliases](./docs-internal/development/INTERNAL_EXTERNAL_ALIASES.md).
729

8-
## For Open Source Contributors
30+
## Making Changes
31+
32+
### For Open Source Contributors
933

1034
1. **Fork and Clone**: Fork the repository and clone it locally.
1135
2. **Branch**: Create a feature or bugfix branch.
@@ -16,7 +40,7 @@
1640
- Link the related GitHub issue (if applicable).
1741
- Validate that required checks pass. We ensure that Rivet's required checks run within < 5 minutes.
1842

19-
## For Rivet Employees
43+
### For Rivet Employees
2044

2145
1. **Branching and Commits**:
2246
- Use [Graphite](https://graphite.dev/) for creating and managing branches.

0 commit comments

Comments
 (0)