Improve how we reference issues in commit message and code

Open
#106 3 comments 0 reactions 0 assignees View on GitHub

@im-anishraj is already working on this.

Since Jan 12, 2026.

  • #239 by @im-anishraj — open

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
git, github
Domain
tooling

Research direction

Start by reviewing how issue references appear in repository code comments and in commit messages. Compare the current #12 convention with the proposed full URL in comments and the Reference URL above the commit signoff; done means the project has an agreed, consistently applied convention.

Written by the indexing model from the issue text.

Description

documentation
Description

Today we use #12 as a reference to an issue.
When the code is move to another repo, 12 will point to another issue.
We should consider switching to something using full URLs in code comments
and this Reference: https://github.com/nexB/dejacode/issues/1198 just above the signoff in commits

Dominant language
Batchfile
Stars
316
Forks
257
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aboutcode-org/aboutcode

All issues in aboutcode-org/aboutcode

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.