diff options
| -rw-r--r-- | hacking.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/hacking.md b/hacking.md new file mode 100644 index 0000000..5a21f2d --- /dev/null +++ b/hacking.md @@ -0,0 +1,27 @@ +--- +title: Hacking on SourceHut +toc: false +--- + +For developers interested in hacking on SourceHut, an expedited installation +procedure is available. The bare minimum is a PostgreSQL database and a Redis +server, and you can generally skip the webhooks daemons unless you need them. +It is recommended that you still use our distribution packages to obtain the +dependencies, though. + +If you don't intend to work on core.sr.ht, install the package to skip this +step. If you don't intend to work on meta.sr.ht, it may be easier to install the +package and configure it normally on localhost than to try and get it up and +running from source. + +You can also *usually* get away without configuring the outgoing mail settings, +but you may still have to generate a PGP key to get things started up. You can +also skip the reverse proxy and use our development servers via `python3 +run.py`. + +# Sending patches + +We use [git send-email](https://git-send-email.io) and discuss patches (and +other development topics) on the +[sr.ht-dev](https://lists.sr.ht/~sircmpwn/sr.ht-dev) list. Please send your +patches and development questions there. |