marcosgriselli / marcosgriselli/EasyTransitions
Add descriptions to objects and methods
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- Swift
- Stars
- 1.7k
- Forks
- 87
- PR merge metrics
- No merged PRs in 30d
Description
In order to have a well documented API we need to describe what each class, struct, enum and method responsibilities are and how to use it.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reviewing the public Swift API, including its classes, structs, enums, and methods, and identify what each is responsible for and how it is used. The work is complete when each API element has a clear description and usage guidance; no specific files or tests are named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ios, swift
- Domain
- documentation, mobile
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100