oddbird / oddbird/css-anchor-positioning
Document and re-organize codebase
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 493
- Forks
- 18
- Avg merge
- 12h 37m
- Merged PRs (30d)
- 5
Description
There currently hasn't been a whole lot of thought put into which functions live in parse.js vs utils.js, and many of the files are quite large. It would be valuable to implement a better file organization structure, as well as add documentation to every function.
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 by reviewing parse.js and utils.js to map the current function organization and identify the other large files involved. Define a coherent file structure and document every function; the work is done when the codebase has been reorganized and all functions have documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100