Improve how we reference issues in commit message and code
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
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
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aboutcode-org/aboutcode
-
Cross-reference OpenChain CRA Compliance ChecklistMay be free again @PaulitePavitra claimed this 41 days ago, and no pull request is open. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
aboutcode-org/aboutcode#309 · 6 comments ·
-
scancode-next: Plan federated software supply chain data infrastructurePossibly taken @ziadhany claimed this 6 days ago. Openmaintainers-only
Difficulty 4/5 3-5 days Newbie friendliness 45/100
aboutcode-org/aboutcode#325 · 2 comments · 2 assignees ·
-
scancode-next: Improve documentation, review documentation issues and pull requestsPossibly taken @hesa claimed this 8 days ago. Openmaintainers-only
aboutcode-org/aboutcode#324 · 1 assignee ·
-
scancode-next: Gather requirements through interviews with key usersPossibly taken @hesa claimed this 8 days ago. Openmaintainers-only
Difficulty 5/5 Over a week Newbie friendliness 25/100
aboutcode-org/aboutcode#323 · 1 assignee ·
-
scancode-next: Prepare ScanCode and AboutCode workshopsPossibly taken @adaaaam claimed this 6 days ago. Openmaintainers-only
aboutcode-org/aboutcode#322 · 1 assignee ·
All issues in aboutcode-org/aboutcode
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
zai-org/zcode-plugins#202 ·
Maintainers usually reply within 1 day
-
application-issue
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Installomator/Installomator#3657 · 1 comment ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Tencent/LoopForge#1084 · 2 comments ·
Maintainers usually reply within 1 day
-
bug debugger flaky small
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Project-N-E-K-O/N.E.K.O#3813 ·
Maintainers usually reply within 1 day