HaxeFlixel / HaxeFlixel/flixel
Better documentation for front-end classes and under the hood
Open
Nobody has claimed this yet.
Easy Change
- Dominant language
- Haxe
- Stars
- 2.2k
- Forks
- 522
- Avg merge
- 34m
- Merged PRs (30d)
- 1
Description
All front-end classes should state how to access them, what they are typically used for, and what under the hood classes they use.
All under the hood classes, should explain what they are typically used for and what uses them
Examples:
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.
Research direction
Start with the front-end classes index and the flixel.system.debug.VCR API page linked in the issue. Inventory the front-end and under-the-hood classes, then document access, typical use, and relationships between them. Done means the requested usage and implementation context is covered consistently across the relevant API pages.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, game-dev
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100