Home » Documentation » Contribution Guidelines

Contribution Guidelines

Introduction

This document explains how to contribute to the uniqush project.

Before contributing, make sure you're comfortable with git and have a GitHub account.

Basic procedure

All uniqush repositories are under the uniqush GitHub organization. To contribute:

  1. Find the repository you want to change.
  2. Fork it.
  3. Make your change in a branch of your fork.
  4. Push the branch to your fork.
  5. Open a pull request against master. It'll be reviewed, and merged if it's a good fit.

Repositories fall into two categories: code repositories (source and libraries) and content repositories (this site, the blog, everything that isn't source).

Questions, bug reports and suggestions are all welcome on GitHub Issues.

Source code repositories

The server is written in Go. master is the branch to work from and to open pull requests against; it should always build and pass go test ./....

Content repositories

This site (uniqush.org) is the uniqush-www repository, built with Hugo and deployed by GitHub Actions on every push to master.

The blog is the uniqush-blog repository, built with Pelican and published alongside this site.

Fork, change, and send a pull request the same way as for code.

Source code is under the Apache 2.0 License. Content on this site and the blog is under the Creative Commons Attribution 3.0 Unported License. Please make sure you've read and accept the relevant one before contributing.