Improve README so that anyone can get set up to contribute
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- git
- Domain
- documentation
Research direction
Start with README.md and review the existing contributor setup guidance, especially the references to Lando and Git. Document the steps needed for a newcomer to set up the project and add a page; done means someone unfamiliar with those tools can follow the README without outside help.
Written by the indexing model from the issue text.
Description
The README page is very light on detail which means that only someone comfortable with Lando, Git etc is able to get set up and contribute new pages.
How can we improve the documentation so that anyone can do this?
- Dominant language
- No language data
- Stars
- 7
- Forks
- 22
- 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 localgovdrupal/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
localgovdrupal/docs#348 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
localgovdrupal/docs#341 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
localgovdrupal/docs#340 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
localgovdrupal/docs#332 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
localgovdrupal/docs#333 ·
All issues in localgovdrupal/docs
Similar issues
-
sync-en
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Maintainers usually reply within 1 day
-
sync-en
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 3 days
-
bug developer portal
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
discord/discord-api-docs#8645 ·
Maintainers usually reply within 1 day
-
Form
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
symfony/symfony-docs#23159 ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day