summaryrefslogtreecommitdiffstats
path: root/guide/src/sw_contribute.md
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-09-20 12:40:12 -0700
committerBryan Newbold <bnewbold@robocracy.org>2018-09-20 12:40:20 -0700
commitf10bcb49d17234dc52c8b67a7b7fd1796ab6f435 (patch)
tree070ef3376b67798b9c81c78c940a09ead51dcf49 /guide/src/sw_contribute.md
parent90f059d1ad87a068b0dce92a965175c6ed158ba1 (diff)
downloadfatcat-f10bcb49d17234dc52c8b67a7b7fd1796ab6f435.tar.gz
fatcat-f10bcb49d17234dc52c8b67a7b7fd1796ab6f435.zip
work in progress on guide (mdbook)
Diffstat (limited to 'guide/src/sw_contribute.md')
-rw-r--r--guide/src/sw_contribute.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/guide/src/sw_contribute.md b/guide/src/sw_contribute.md
new file mode 100644
index 00000000..17d72785
--- /dev/null
+++ b/guide/src/sw_contribute.md
@@ -0,0 +1,14 @@
+# Software Contributions
+
+For now, issues and patches can be filed at <https://github.com/bnewbold/fatcat>.
+
+To start, the back-end (fatcatd, in rust), web interface (fatcat-web, in
+python), bots, and this guide are all versioned in the same git repository.
+
+See the `rust/README` and `rust/HACKING` documents for some common tasks and
+gotchas when working with the rust backend.
+
+When considering making a non-trivial contribution, it can save review time and
+duplicated work to post an issue with your intentions and plan. New code and
+features will need to include unit tests before being merged, though we can
+help with writing them.