summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan Davison <dandavison7@gmail.com>2022-09-06 19:38:44 -0400
committerDan Davison <dandavison7@gmail.com>2022-09-06 19:39:47 -0400
commit06cbbf7cc481ad0f75a4c5b2345dce3bc68ef09e (patch)
tree5313c991a421602682b27725f20c45655907570b
parentab39c1dc0f633d11b6f33c397dd3d0ef0a63ce5d (diff)
Edit CONTRIBUTING.md
-rw-r--r--CONTRIBUTING.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 48caed7d..81349442 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,13 +1,15 @@
-# Contribution guidelines
+# Notes on contributing to delta
First off, thank you for considering contributing to delta.
If your contribution is not straightforward, please first discuss the change you
wish to make by creating a new issue before making the change.
-## Developing
+## The codebase
-### Set up
+Take a look at [ARCHITECTURE.md](./ARCHITECTURE.md).
+
+## Set up
This is no different than other Rust projects.
@@ -19,7 +21,7 @@ cargo build --release
The executable is then at `./target/release/delta`.
-### Useful Commands
+## Useful Commands
- Run all tests: