alphapapa / alphapapa/magit-todos

Idea: use (magit-get-upstream-ref) as ref commit

Open
#155 10 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue help wanted
Dominant language
Emacs Lisp
Stars
792
Forks
54
PR merge metrics
No merged PRs in 30d

Description

This is just an idea/suggestion. I see that magit-todos uses `(magit-main-branch)` to figure out (using `merge-base`) the revision to compare the HEAD against.

How about using `(magit-get-upstream-ref)` instead? I'm suggesting this, because people might not update their `main` branch for a long time, so it gets out of sync, and `merge-base` may find some very ancient revision, so we get a lot of entries in the TODO list.
On the other hand, `(magit-get-upstream-ref)` is usually more up-to-date, and it also more likely contains a more relevant revision to find the merge base.

What do you think?

I've been using this idea for a while, and it seems to work for me. If anyone interested, I use this snippet to achieve this:

```lisp
(defun my-magit-mode-hook ()
(let ((upstream (magit-get-upstream-ref)))
(when upstream
(setq magit-todos-branch-list-merge-base-ref upstream)))
(add-hook 'magit-mode-hook 'my-magit-mode-hook)
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.