diff options
Diffstat (limited to 'guide/src/sw_contribute.md')
-rw-r--r-- | guide/src/sw_contribute.md | 14 |
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. |