Mention "The XY Problem" in bug reporting guide
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Locate the contributor documentation's bug reporting guide and read its existing guidance on describing problems and goals. Add a brief explanation of the XY Problem, link to xyproblem.info, and explain how reporters can state the underlying goal; done means the guide clearly covers this case.
Written by the indexing model from the issue text.
Description
A common type of bug report we get is someone asking how to do Y, when they really want do Y to solve X.
This is a documented phenomenon here: http://xyproblem.info/
It might be worth mentioning this and how to avoid it in our bug reporting docs.
- Dominant language
- No language data
- Stars
- 5
- Forks
- 4
- Avg merge
- 23h 9m
- Merged PRs (30d)
- 1
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 elementary/contributor-docs
-
LocalizationOpenNeeds Copy
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
-
Add footer links to HIG and Contributor GuideMay be free again @LuminousHustler claimed this 287 days ago, and no pull request is open. OpenGood First Issue Status: Blocked
elementary/contributor-docs#24 · 4 comments · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
elementary/contributor-docs#14 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
elementary/contributor-docs#13 · 2 comments · 2 reactions ·
-
Needs Copy
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
All issues in elementary/contributor-docs
Similar issues
-
documentation good first issue help wanted
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
zmo2s/agent-toolbox#23 ·
-
✨ enhancement needs-discussion
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
clawsweeper:needs-maintainer-review clawsweeper:no-new-fix-pr issue-rating: 🌊 off-meta tidepool P3
Difficulty 2/5 Half a day Newbie friendliness 62/100
openclaw/openclaw#168070 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
-
agent: ready area: submission priority: high type: docs
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
dkritarth/scopewatch#213 ·
Maintainers usually reply within 1 day
-
Broken link in RELEASE.mdPossibly taken @Jah-yee claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
sphinx-contrib/httpdomain#143 ·
Maintainers usually reply within 1 day