SIT

Serverless issue tracker for decentralized teams

[ Download | Getting Started | Overview | Issues & Merge Requests ]

SIT is a compact tool to track and share project issues in and between decentralized teams. Its goal is to lower the barrier for having an independently operated, shared issue tracker. Instead of having to setup and maintain a server and a database, or having to rely on services of an external third party, SIT can be initialized and started as simply as this:

$ sit init && sit-web

That's it. Now you can check out the Getting Started guide.

(An example of running sit-web)

Why Should I Care?

As far as analogies go, we're doing to issue tracking what Git did to version control systems. But let us further elaborate on a few benefits to consider:

Works offline. You can synchronize the issues, go offline and work on them without needing a connection. You can synchronize at any time later.
Contextualizes state. When used together with an SCM (such as Git), you can see the state and status of any issue at any given revision ("what release branches is this closed on?")
Continuously localizes data. You can access the data at any time. No API rate limits. It's on your filesystem.
Adapts to your team topology. Synchronization can be done over Git, Dropbox, Keybase, USB flash drives or anything else that allows you to copy files between computers.
Malleable. You can make it handle workflows and payloads original authors never anticipated. The customization is in its blood.

Project Status

It is in the early adopter stage. It's usable but not everything is done yet and some things will change. We're publishing releases regularly but always encourage trying out the latest and greatest master branch.

Obtaining SIT

All our releases are hosted on GitHub and binary files can be downloaded from there.

Build Instructions

As SIT is currently in its early days, sometimes it might make sense to use a pre-release build. We encourage that. It helps us building a better product.

Firstly, you will need to install Rust 1.24.1. Luckily it is typically a very simple process. You can find instructions on Rust's website.

Now, after that has been taken care of, time to check out SIT and build it:

git clone https://github.com/sit-it/sit
cd sit
cargo build --release

Now, you can copy target/release/sit and target/release/sit-web to your PATH or add /path/to/target/release to PATH to always have the most recent version available.

Questions, Bug Reports, etc.?

SIT's is using SIT for tracking issues (duh!) and because of this, GitHub issues are turned off. It's a good excuse to try out SIT if you have an issue to file!

You will get all issue updates when you fetch this git repository. All updates will come through it as well.

Simply run sit-web in this repository's clone and open it in the browser.

Send Updates to Upstream

Once you've used sit-web or ./scripts/prepare-merge-request to work on the issues, you can send the updates to this repository:

Create a branch (as a convention, you can use your issue ID or an added record ID as a branch name, but free to choose anything else, preferrably unique)
Add new files in .sit and commit them. Commit message can be simply "Added issue " or, say, "Commented on issue "
Push it out to the Inbox: GIT_SSH_COMMAND="ssh -i sit-inbox" git push git@git.sit-it.org:sit-it/sit-inbox.git <branch>
If the commit only contains new records (nothing else is permitted!) the Inbox will accept the push and immediately forward it to sit's master repository on GitHub. Otherwise, the push will be rejected.

To further simplify the process of sending records to the upstream, it's highly recommended to add a remote (such as issues) for git@git.sit-it.org:sit-it/sit-inbox.git and this to your ~/.ssh/config:

host git.sit-it.org
  HostName git.sit-it.org
  IdentityFile /path/to/sit/repo/sit-inbox
  User git

This way, pushing out, will be as nice as git push issues <branch>

Preparing a merge request

Please refer to CONTRIBUTING for the instruction.

License

SIT is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.

Credits

Shout-out to Ura Design for designing our logo. They help with design magic for open source projects.

Contributing

This project is in its very early days and we will always be welcoming contributors.

Our goal is to encourage frictionless contributions to the project. In order to achieve that, we use Unprotocols' C4 process as an inspiration. Please read it, it will answer a lot of questions. Our goal is to merge patches as quickly as possible and make new stable releases regularly.

In a nutshell, this means:

We merge patches rapidly (try!)
We are open to diverse ideas
We prefer code now over consensus later

To learn more, read our contribution guidelines

adymitruk/sit

SIT