Contributing

How to build GitSocial, submit a pull request or report a bug.

Get started · Submit a pull request · Report a bug or request a feature

Get started

Issues and pull requests are disabled on each forge copy of this repository (GitHub, for example); GitSocial uses its own tools for collaboration.

1. Install GitSocial (see Install)
2. Fork the repository on any host (GitHub, GitLab, Codeberg, or self-hosted)
3. Clone your fork: git clone https://your-host.com/you/gitsocial
4. Build it with Go 1.25.8 or newer: go build -o bin/ ./...
5. Read Architecture for system design, packages, and cache layout

Submit a pull request

git config core.hooksPath scripts/hooks   # install the pre-push hook, once per clone
git switch -c feature/my-change           # make changes, commit
scripts/check.sh --quick                  # the quick tier that the hook runs on push

gitsocial review pr create \
  --base main \
  --head feature/my-change \
  "Short description of change"

git push origin feature/my-change         # push your branch
gitsocial push                            # push the pull request

After your first push, request fork registration in the Matrix room. A maintainer then runs gitsocial fork add <your-fork-url> and sees your pull requests and issues.

See Review for the full cross-forge pull request workflow.

Report a bug or request a feature

gitsocial pm issue create "Bug: description"
gitsocial push

The issue is in your repository, and maintainers can see it after fork registration. For short questions or discussion, use the same Matrix room.