Bug-fixing Checklist ?
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
No file or test is named; start by reviewing the repository's existing contribution guidelines and the issue discussion. If maintainers agree, document a bug-fixing checklist covering code comments linked to bug reports and regression tests with unambiguous issue links.
Written by the indexing model from the issue text.
Description
Often I come across code in a "mature" codebase that I have no idea how it got there.
should we add a section on bug-fixing encouraging (requiring?) people to:
- add a code comment linking to a bug report in the code...?
- create a regression test with a clear and link to the github issue that unambiguously fixes the issue.
- Dominant language
- No language data
- Stars
- 92
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No 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 dwyl/contributing
-
bug chore starter
Difficulty 1/5 Under an hour Newbie friendliness 38/100
dwyl/contributing#119 · 1 reaction ·
-
enhancement starter
Difficulty 1/5 1-3 hours Newbie friendliness 35/100
dwyl/contributing#118 · 1 reaction ·
-
discuss enhancement
Difficulty 4/5 3-5 days Newbie friendliness 25/100
dwyl/contributing#113 · 2 reactions ·
-
discuss enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
dwyl/contributing#112 · 1 reaction ·
-
Draft Pull Requests!Opendiscuss enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
dwyl/contributing#111 · 2 comments · 3 reactions ·
All issues in dwyl/contributing
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
zerocracy/judges-action#2730 ·
Maintainers usually reply within 8 days
-
feedback simulation workshop
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
githubnext/gh-aw-workshop#4417 ·
Maintainers usually reply within 1 day
-
documentation Good First Issue hacktoberfest Non-Code
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
hiero-ledger/hiero-sdk-js#4488 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
crazy-goat/rabbit-stream#830 ·
Maintainers usually reply within 1 day
-
sync-en
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day