Radish alpha
h
Radicle Heartwood Protocol & Stack
Radicle
Git (anonymous pull)
Log in to clone via SSH
CONTRIBUTING/HACKING: Add note on direnv
✓ CI success Fintan Halpenny committed 16 days ago
commit 669e3235a91008f9de5d4e8bef4d699acd120f43
parent 180d48c65d496d5bb2233fb04ff2ea7c0fe5d56b
1 passed (1 total) View logs
2 files changed +11 -0
modified CONTRIBUTING.md
@@ -286,4 +286,10 @@ 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 `source_env .envrc.sample` in 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.
+

[1]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
modified HACKING.md
@@ -185,3 +185,8 @@ 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 `source_env .envrc.sample` in 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.