maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(CONTRIBUTING): mention magrathea (and direnv)

Browse source 
Change-Id: I226b9e56ebd74a2bcb8bf1427fc2403348826abe
Reviewed-on: https://cl.tvl.fyi/c/depot/+/13030
Tested-by: BuildkiteCI
Autosubmit: sterni <sternenseemann@systemli.org>
Reviewed-by: tazjin <tazjin@tvl.su>
This commit is contained in:
sterni 2025-01-21 14:53:14 +01:00 • committed by clbot
parent 507495de5b
commit edf4bf6165
1 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/CONTRIBUTING.md
View file

@ -112,7 +112,10 @@ repository, you can usually build the project by calling `nix-build -A
path.to.project`. path.to.project`.
For example, to build a project located at `//tools/foo` you would call For example, to build a project located at `//tools/foo` you would call
`nix-build -A tools.foo` `nix-build -A tools.foo` from the repository root. `//tools/magrathea`
(which is added to `PATH` automatically if you enable [direnv][])
allows you to do the same via `mg build //tools/foo`
regardless of what your working directory is.
If the project has tests, check that they still work before submitting your If the project has tests, check that they still work before submitting your
change. change.
@ -127,3 +130,4 @@ review][] documentation.
[code review]: ./REVIEWS.md [code review]: ./REVIEWS.md
[Conventional Commits]: https://www.conventionalcommits.org [Conventional Commits]: https://www.conventionalcommits.org
[Importing projects into depot]: ./importing-projects.md [Importing projects into depot]: ./importing-projects.md
[direnv]: https://direnv.net