shakna-israel / git-issues

A git extension for issue management

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

git-issues

A git extension for issue management


git-issues is an extension for git that adds issue management to the repository.

It is designed to be used by the extension, but care has been taken to ensure it can also be used by those who wish to use other tools to manage the issues.


Stability

git-issues is still under active development, and is not yet in a working state.

Using it will probably screw up your git tree.

Documentation likely points to incorrect information, and information that is not yet correct (i.e. Talks about unimplemented features).

Until git-issues is in a usable state, the version number will remain 0.0.0

When git-issues is in a usable state, issues will continue to be managed by th git provider (i.e. GitHub), as if you're having issues with git-issues, you may not be able to use it to raise issues here.

Roadmap

  • Installer
  • Uninstaller
  • Open Issues
  • Close Issues
  • Comment Issues
  • Tag Issues
  • List Issues
  • Issues Graph
  • Issues Log
  • Issues Rate
  • Issues TUI
  • vim plugin
  • emacs plugin
  • Atom plugin
  • Issues Sync
  • 1.0.0

Usage

See git-issues help

or

run:

git issues help

Installation

Platform Support

  • Linux
    • Fully supported
  • BSD
    • May work. Please raise issues if you have them.
  • macOS
    • May work. Please raise issues if you have them.
  • Cygwin
    • May work. Sorry, I can't help if you encounter problems.

Prequisites

These tools need to be installed and in your PATH:

  • git
  • make
  • grep
    • usually pre-installed
  • sha512sum
    • usually pre-installed
  • cut
    • usually pre-installed
  • tr
    • usually pre-installed
  • readlink
    • usually pre-installed
    • macOS users may need to install GNU Readlink.
  • less
    • usually pre-installed
    • Or set $PAGER to some other pager utility.
  • dialog or whiptail
    • optional, used for tui

Note: If any tool is not found, then git-issues will complain in a helpful manner.


Install

make install

Note: May need to run as root. (e.g. sudo make install).

You can also specify PREFIX to change the default install location. (This destination will also be remembered by the uninstall script.)

Uninstall

git issues uninstall

Note: May need to run as root, depending on where you installed it. (e.g. sudo git-issues uninstall).


Contributing

All contributions should follow the instructions found in the CONTRIBUTING.md file.


License

Effectively public domain, however the full legal code can be found in the LICENSE file.

Released under Creative Commons 0 license.

About

A git extension for issue management

License:Creative Commons Zero v1.0 Universal


Languages

Language:Shell 87.4%Language:Makefile 12.6%