Skip to content

Latest commit

 

History

History
95 lines (73 loc) · 3.56 KB

README.md

File metadata and controls

95 lines (73 loc) · 3.56 KB
Raw

Maintainer's Note

I have not had as much time for extra-curriculars as I once had. At this point, I will never catch up to the obvious successor of this package, Forge, nor would I really want to 😄

Please check out that project instead! I believe there are things a GitHub-specific package could do that don't make sense to generalize, but Forge has served me well for the 95%.

If you have a vision and would like to take over maintainership, reach out!

Overview -- the status buffer

Magithub

MELPA Status Build Status Gitter MELPA Stable Status GitHub Commits

Magithub is a collection of interfaces to GitHub integrated into Magit workflows:

  • Push new repositories
  • Fork existing ones
  • List and create issues and pull requests
  • Keep offline notes for your eyes only
  • Write comments
  • Manage labels and assignees
  • Stay up-to-date with status checks (e.g., CI) and notifications
  • ...

as well as support for working offline.

Happy hacking!

Quick Start

GitHub rate-limits unauthenticated requests heavily, so Magithub does not support making such requests. Consequently, ghub must be authenticated before using Magithub -- see its README for those instructions.

(use-package magithub
  :after magit
  :config
  (magithub-feature-autoinject t)
  (setq magithub-clone-default-directory "~/github"))

See the full documentation for more details.

Getting Help

See the FAQ in the full documentation. If your question isn't answered there, drop by the Gitter room.

Support

I'm gainfully and happily employed with a company that frowns on moonlighting, so unfortunately I can't accept any monetary support. Instead, please direct any and all support to Magit itself!

Note

There used to be another magithub: nex3/magithub. It's long-since unsupported and apparently has many issues (see nex3/magithub#11 and nex3/magithub#13) and was removed from MELPA some years ago. If you have it installed or configured, you may wish to remove/archive that configuration to avoid name-clash issues. Given that the package has been defunct for over three years and is likely abandoned, the present package's name will not be changing.