# Tasks

## DONE Support override via git config {#task-7695d33d-e96e-d313-b74b-860addde01c3}
- DONE in 2021-06-12

  Done in
  [`dc51a628910eb872430e108084e81ee37f6e7dff`](https://git.euandreh.xyz/git-permalink/commit/?id=dc51a628910eb872430e108084e81ee37f6e7dff).
- TODO in 2021-06-12

## DONE Write `README.md`, `description` and `long-description` {#task-9bc160b8-5739-133d-1d46-61ba68ebd39e}
- DONE in 2021-06-12

  Finished `README.md` in
  [`d64e4491e417e31f35d3637ded05f5175c19b071`](https://git.euandreh.xyz/git-permalink/commit/?id=d64e4491e417e31f35d3637ded05f5175c19b071).
- DOING in 2021-06-12

  The `description` was already good enough.

  The `long-description` has better content over the previous duplication of whatever was in `description`.
	Done in
  [`9e089d29ec64936df39b9b1a0e385f988d843416`](https://git.euandreh.xyz/git-permalink/commit/?id=9e089d29ec64936df39b9b1a0e385f988d843416).

  The `README.md` is less empty, but still missing a "Usage" section.
  Done in
  [`a9022eb2f72efd9b99212a057df33cba762cd13b`](https://git.euandreh.xyz/git-permalink/commit/?id=a9022eb2f72efd9b99212a057df33cba762cd13b).
- TODO in 2021-06-12

## DONE Write tests {#task-fd654661-fa97-83db-1d49-83a66866ccfa}
- DONE in 2021-06-12

  I didn't find a simple way to test without getting too much into the weeds with mocking Git, and I don't think it is worth it.

  The tests I created are actually just exercising the help and versions flags, and asserting that other flags are ignored.
  For effectiveness this is pretty shallow and pretty useless, but I'm fine with the state of not testing the core functionality.

	To do that it would require me to split `src/git-permalink.sh` into two files, one with the function definitions and the other as a runner.
  But then I would have to glue them together on the `install` target, and more similar complications.

  Given all that, I chose not to write more tests, and call this done.

  Done in
  [`50a7c011274359ef058d30be87b9d29ca4fd06ed`](https://git.euandreh.xyz/git-permalink/commit/?id=50a7c011274359ef058d30be87b9d29ca4fd06ed).
- TODO in 2021-06-12

## TODO Write manpage {#task-6e6f917f-26ad-09fd-9a09-84b5df0f3ea4}
- TODO in 2021-06-12

---

Show example of how to create an override URL on `git config` from a known URL.

## DONE Support default flags {#task-a66edd2e-cec4-ef7d-5a8a-3c9013381719}
- DONE in 2021-06-12

  Done in
  [`9aded035e3a6ab3fbac3129353db587b22132c79`](https://git.euandreh.xyz/git-permalink/commit/?id=9aded035e3a6ab3fbac3129353db587b22132c79).
- TODO in 2021-06-12

---

Those are:
- `-h`
- `--help`
- `-V`
- `--version`

## TODO Support more forges {#task-cebc5298-17ad-5c60-dfa5-a25b66433a3a}
- TODO in 2021-06-12

---

The ones done so far as of this writing:

- <input type="checkbox" disabled checked/> git.euandreh.xyz
- <input type="checkbox" disabled checked/> sourcehut
- <input type="checkbox" disabled checked/> savannah
- <input type="checkbox" disabled checked/> gitlab
- <input type="checkbox" disabled checked/> github

The one I can think of right now but almost never use to merit being
part of the first version:

- <input type="checkbox" disabled /> Kernel CGit (where Git itself in publicly available)
- <input type="checkbox" disabled /> codeberg
- <input type="checkbox" disabled /> notabug
- <input type="checkbox" disabled /> pagure
- <input type="checkbox" disabled /> bitbucket
- <input type="checkbox" disabled /> generic cgit?

# Bugs

# Improvements

# Questions

# Resources

# Scratch