5d8988b CONTRIBUTING/HACKING: Add note on direnv — heartwood

rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5

Radicle Heartwood Protocol & Stack

CONTRIBUTING/HACKING: Add note on direnv

Adrian Duke committed 7 days ago

commit 5d8988b1a242cb1ef006313cb0aa3756e629a422
parent 8af0b62

2 files changed +15 -0

modified CONTRIBUTING.md

@@ -286,4 +286,12 @@ When it comes to formatting, here's a model git commit message[1]:

 ---
 ### Using `direnv`
 The team maintains an `.envrc.sample` file (see [direnv](https://direnv.net/)), that contributors may choose to copy or symlink to their local `.envrc` file.
 This provides some basic tooling and setup that is common to the team.
 For example, if `nix` is installed, the `flake.nix` and `rust-toolchain.toml` files are automatically watched for updates.
 _NOTE: It is suggested you do not use `source_env .envrc.sample` in your `.envrc` as [`direnv`'s security checks](https://direnv.net/man/direnv-stdlib.1.html#codesourceenv-ltfileordirpathgtcode) are not triggered when changes are made to `.envrc.sample`._
 [1]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

modified HACKING.md

@@ -185,3 +185,10 @@ OpenSSH tools to interact with them, eg. `ssh-add`.

 Your Radicle secret key is protected with a passphrase (See: `$RAD_PASSPHRASE`).
 ## Using `direnv`
 The team maintains an `.envrc.sample` file (see [direnv](https://direnv.net/)), that contributors may choose to copy or symlink to their local `.envrc` file.
 This provides some basic tooling and setup that is common to the team.
 For example, if `nix` is installed, the `flake.nix` and `rust-toolchain.toml` files are automatically watched for updates.
 _NOTE: It is suggested you do not use `source_env .envrc.sample` in your `.envrc` as [`direnv`'s security checks](https://direnv.net/man/direnv-stdlib.1.html#codesourceenv-ltfileordirpathgtcode) are not triggered when changes are made to `.envrc.sample`._