about summary refs log tree commit diff
path: root/net
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2022-05-16T18·38+0200
committerclbot <clbot@tvl.fyi>2022-05-16T18·45+0000
commit224eb8a3a3b3eee8140a9b614cf9a12e8c75b11a (patch)
tree64d56eaf6d69a3803a3ee047528da06f1aba9286 /net
parent94cf85c5ccfb3d9be4aaaa57fdea1d7c0a548b4f (diff)
docs(alcoholic_jwt): add 'contributing' section to docs r/4089
Change-Id: Iaa06b3a7d643a2688d43275aedf708fa4208586c
Reviewed-on: https://cl.tvl.fyi/c/depot/+/5622
Autosubmit: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI
Reviewed-by: grfn <grfn@gws.fyi>
Diffstat (limited to 'net')
-rw-r--r--net/alcoholic_jwt/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/net/alcoholic_jwt/README.md b/net/alcoholic_jwt/README.md
index dbb750e3b162..c6da0ab8da89 100644
--- a/net/alcoholic_jwt/README.md
+++ b/net/alcoholic_jwt/README.md
@@ -54,7 +54,19 @@ This library aims to only use trustworthy off-the-shelf components to
 do the work. Cryptographic operations are provided by the `openssl`
 crate, JSON-serialisation is provided by `serde_json`.
 
+## Contributing
+
+This project is developed in the [TVL monorepo][depot]. To work on it,
+you can either use a local clone of the entire repository or clone
+just the `alcoholic_jwt` subtree:
+
+    https://code.tvl.fyi/depot.git:/net/alcoholic_jwt.git
+
+Please follow the TVL [contribution guidelines][contributing].
+
 [Google]: https://www.google.com/
 [Aprila]: https://www.aprila.no/
 [JWKS]: https://tools.ietf.org/html/rfc7517
 [`kid` claim]: https://tools.ietf.org/html/rfc7515#section-4.1.4
+[depot]: https://code.tvl.fyi/
+[contributing]: https://code.tvl.fyi/about/docs/CONTRIBUTING.md