Explain contributing.md
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by locating the project-specific quirks in the current contributor guide and identify which repositories need their own CONTRIBUTING.md files. Review the linked elementary/icons CONTRIBUTING.md as prior art, then update the relevant repository guides and add the proposed intro section explaining where to look. Done means the duplicated quirks are moved and the contributor-docs introduction points readers to repository-level CONTRIBUTING.md files.
Written by the indexing model from the issue text.
Description
Problem
Currently we have some project specific quirks in the contributor guide, but this is sometimes duplicate information and better kept in CONTRIBUTING.md files in each project to stay current. GitHub also surfaces contributing information when it's present, so there's some incentive to have it there in the repo
Proposal
We should move the current quirk info into CONTRIBUTING files on the relevant repos and instead add a section to the intro about looking for CONTRIBUTING.md files on the project repo
Prior Art (Optional)
https://github.com/elementary/icons/blob/master/CONTRIBUTING.md
- 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
-
good first issue hacktoberfest
Difficulty 2/5 Half a day Newbie friendliness 70/100
HelpCode-ai/anythingmcp#996 ·
Maintainers usually reply within 1 day
-
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
-
enhancement low-priority milestone-qa tests
Difficulty 1/5 Under an hour Newbie friendliness 85/100
lognorman20/monaco#4858 ·