rudi
/
kbtui
mirror of https://github.com/Rudi9719/kbtui.git
1
0
Fork 0
Code Issues Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
318 Commits
8 Branches
2 Tags
681 KiB
 
Tree: 549e9f8ad6
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '549e9f8ad6'
${ noResults }
kbtui/CONTRIBUTING.md

1.4 KiB
Raw Blame History

Welcome to kbtui!

An application for those who want to use Keybase, but don't want to leave the comfort of their terminal.

Basic Rules

Thank you for taking the time to contribute to this project! There are two main rules:

  • Don't be rude
  • Keep it simple, stupid

There is nothing to be gained by being rude anywhere; contributions to this project are no different. Also when in doubt, simplify everything. There are other people who are reading, forking, and working on this project. See the style guidelines below in the Getting Started section.

Pull Requests

In order for a PR to be accepted it must be two things:

  • Reviewed by @dxb or @rudi9719
  • Consistent with the Go formatting guidelines below.

Getting Started!

Please read through Effective Go and Style guidelines for go. If you're having difficulties getting started I suggest you try to learn go with tests.

It might also help to read the godoc for @dxb's Keybase framework, as well as the godoc for gocui, the library we're using for the TUI. Please note, we're using the awesome-gocui version of gocui.