shithub Public

Watch 1 Fork 0 Star 0
markdown · 1872 bytes Raw Blame History

Issues

Issues track bugs, ideas, and conversations against a repository. Anyone with read access to a repo can see its issues; opening and commenting depends on the repo's settings (open to all logged-in users by default).

Opening an issue

Repo → Issues → "New issue". Required:

  • Title — one line.
  • Body — markdown (reference). Drag-and-drop attachments upload to the repo's blob store.

Optional:

  • Labels — colored tags maintainers use for triage.
  • Assignees — who's expected to handle it.
  • Milestone — group issues toward a release/target.

References

shithub auto-links these in issue + comment bodies:

  • #123 — issue or PR in this repo.
  • owner/repo#123 — issue or PR in another repo.
  • @username — user mention; they get a notification.
  • @org/team — team mention; every member is notified.
  • Commit SHAs (full or 7+ chars) — link to the commit page.

Closing

Three ways an issue closes:

  • Manually, via the "Close" button.
  • Via a referenced commit/PR — Fixes #123 or Closes #123 in a merged PR's title or body auto-closes the issue.
  • Via API.

Closed issues stay visible; you can reopen them.

Comments + reactions

Each comment supports the same markdown as the body. Reactions (👍 👎 😄 🎉 😕 ❤️ 🚀 👀) live on every issue/comment as a way to signal agreement without adding "+1" noise.

Locking

Maintainers can lock a conversation. Locked issues accept no new comments or reactions; existing content stays.

The Issues list supports filters:

  • is:open / is:closed
  • author:<user>
  • assignee:<user>
  • label:"good first issue"
  • milestone:"v1.0"
  • mentions:<user>
  • commenter:<user>
  • Sort: newest, oldest, most commented, recently updated.

Free-text after the filter narrows by title + body.

View source
1 # Issues
2
3 Issues track bugs, ideas, and conversations against a repository.
4 Anyone with read access to a repo can see its issues; opening and
5 commenting depends on the repo's settings (open to all logged-in
6 users by default).
7
8 ## Opening an issue
9
10 Repo → Issues → "New issue". Required:
11
12 - **Title** — one line.
13 - **Body** — markdown ([reference](./markdown.md)). Drag-and-drop
14 attachments upload to the repo's blob store.
15
16 Optional:
17
18 - **Labels** — colored tags maintainers use for triage.
19 - **Assignees** — who's expected to handle it.
20 - **Milestone** — group issues toward a release/target.
21
22 ## References
23
24 shithub auto-links these in issue + comment bodies:
25
26 - `#123` — issue or PR in this repo.
27 - `owner/repo#123` — issue or PR in another repo.
28 - `@username` — user mention; they get a notification.
29 - `@org/team` — team mention; every member is notified.
30 - Commit SHAs (full or 7+ chars) — link to the commit page.
31
32 ## Closing
33
34 Three ways an issue closes:
35
36 - Manually, via the "Close" button.
37 - Via a referenced commit/PR — `Fixes #123` or `Closes #123` in a
38 merged PR's title or body auto-closes the issue.
39 - Via API.
40
41 Closed issues stay visible; you can reopen them.
42
43 ## Comments + reactions
44
45 Each comment supports the same markdown as the body. Reactions
46 (👍 👎 😄 🎉 😕 ❤️ 🚀 👀) live on every issue/comment as a way to
47 signal agreement without adding "+1" noise.
48
49 ## Locking
50
51 Maintainers can lock a conversation. Locked issues accept no new
52 comments or reactions; existing content stays.
53
54 ## Filters and search
55
56 The Issues list supports filters:
57
58 - `is:open` / `is:closed`
59 - `author:<user>`
60 - `assignee:<user>`
61 - `label:"good first issue"`
62 - `milestone:"v1.0"`
63 - `mentions:<user>`
64 - `commenter:<user>`
65 - Sort: newest, oldest, most commented, recently updated.
66
67 Free-text after the filter narrows by title + body.