~sircmpwn/sr.ht-docs

c55b64e1452809322ee3805f9f051ba87293269e — Drew DeVault 2 months ago e62d312
Add hacking.md
1 files changed, 27 insertions(+), 0 deletions(-)

A hacking.md
A hacking.md => hacking.md +27 -0
@@ 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.