diff --git a/README.md b/README.md new file mode 100644 index 0000000..9c5ef35 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# How to contribute + +1. Generate an SSH key pair via `ssh-keygen` in your terminal (make sure not to overwrite an existing key!). + +2. Add the configuration in `.ssh/config` to your local SSH configuration file. + +3. Point the `IdentityFile` parameter to your local key file location (in most cases `~/.ssh/id_ed25519` or equivalent with RSA). + +4. Go into your Gitea Settings, then SSH/GPG Keys section, then upload your public key (in most cases, a file called `id_ed25519.pub`). + +5. You can now contribute code!