Skip to content

Commit

Permalink
WIP readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
abey79 committed Nov 27, 2024
1 parent 910bd00 commit 8a0738a
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ This is written for anyone who wants to contribute to the Rerun repository.

You can also look at our [`good first issue` tag](https://github.com/rerun-io/rerun/labels/good%20first%20issue).

## Git LFS

We use [git-lfs](https://git-lfs.com/) to store big files in the repository.
Make sure you have it installed (running `git lfs ls-files` from the repository root should list some files).
Don't forget to run `git lfs install` after installing the git-lfs binary.
If the CI complains about this, make sure you run `git add --renormalize .`.

## Pull requests
We use [Trunk Based Development](https://trunkbaseddevelopment.com/), which means we encourage small, short-lived branches.

Expand Down

0 comments on commit 8a0738a

Please sign in to comment.