lukasjarosch / lukasjarosch/skipper
Document class concept
Open
Nobody has claimed this yet.
type/docs
- Dominant language
- Go
- Stars
- 12
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Classes are a core part of Skipper.
The concept needs to be documented precise and understandable, along with examples.
### Todo
- [ ] Class core concepts and rules
- [ ] Class usages
- [ ] Example of a class
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
Locate the repository's existing documentation entry point and the class implementation, then read how classes are currently used. Document the core concepts and rules, common usages, and one representative class example; done means all three checklist items are covered clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100