Better Readme
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- swift
- Domain
- documentation
Research direction
Start by reading README.md and comparing its organization with the linked iOS Open source Readme Template. Clarify the desired sections and structure with the maintainers before editing; done means the README is reorganized and the resulting guidance is no longer confusing.
Written by the indexing model from the issue text.
Description
The README.md is a little bit confusing.
I created this iOS Open source Readme Template so you can take a look on how to better organize.
If you want, I can help you to organize the README.md.
What are your thoughts?
- Dominant language
- Swift
- Stars
- 130
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Contributor 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.
Similar issues
-
area:dictation documentation P2
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
uttrflow/uttrflow-swift#1180 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
OneBusAway/onebusaway-ios#1451 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
type: docs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
googleapis/google-cloud-swift#971 ·