Merge branch 'contrib-setup' into 'main'

docs: explain how to contribute to web site and code

Closes obnam#140

See merge request obnam/obnam.org!55

1 files changed, 47 insertions, 2 deletions

diff --git a/contributing.md b/contributing.md
index 8d8980e..dde5d5d 100644
--- a/contributing.md
+++ b/contributing.md
@@ -1,5 +1,7 @@
 [[!meta title="Contributing to Obnam"]]
 
+[[!toc]]
+
 The Obnam project welcomes contributions. If you want to help Obnam
 become better, you can. There are many ways to contribute that don't
 involve writing code.
@@ -27,7 +29,50 @@ We co-ordinate our work via the gitlab.com [issue tracker][]. Using it
 requires an account on the site: if that's a problem for you, please
 get in touch and we may be able to arrange something.
 
-[issue tracker]: https://gitlab.com/larswirzenius/obnam/-/issues
+[issue tracker]: https://gitlab.com/obnam/obnam/-/issues
+[web site repository]: https://gitlab.com/obnam/obnam.org
+[code repository]: https://gitlab.com/obnam/obnam
+
+# Set up to change the web site
+
+To contribute a change to the web site, you set up like this:
+
+* Fork the [web site repostiory][].
+  - you will need your own account on gitlab.com for this
+* Clone the code from your fork.
+* Make a new git branch and start making changes.
+* Commit everything.
+* Push your changes back to your fork.
+* Make a merge request from your fork to the main project.
+
+You can, if you want to, test your changes by building a local copy of
+the website, but that's not required.
+
+# Set up to change the code
+
+If you want to make a contribution by changing the code, you can set
+up an environment following these steps:
+
+* Install the [Rust][] language toolchain, using [rustup][].
+  - using a toolchain packaged for, say, Debian, may also work, but may
+    be old
+* Install any other build dependencies, as described in the [README][]
+  and [debian/control] files.
+* Fork the [code repository][]:
+  - you will need your own account on gitlab.com for this
+* Clone the code from your fork.
+* Run `./check` to make sure everything works.
+* Make a new git branch and start making changes.
+  - make sure `./check` works with your changes
+* Commit everything.
+* Push your changes back to your fork.
+* Make a merge request from your fork to the main project.
+
+[Rust]: https://www.rust-lang.org/
+[rustup]: https://www.rust-lang.org/tools/install
+[README]: https://gitlab.com/obnam/obnam/-/blob/main/README.md
+[debian/control]: https://gitlab.com/obnam/obnam/-/blob/main/debian/control
+[gitlab]: https://gitlab.com/obnam/obnam/
 
 # Getting Obnam to change so you can do what you want to do
 
@@ -82,7 +127,7 @@ place:
   be able to comment.
 * Lars may update the MR based on feedback, applying his best
   judgment.
-  
+
 Typical values for N will be:
 
 * 0 for typo fixes and similar low-impact changes, or fixes to