github-samples / github-samples/caldova-careers
Document and apply coding standards
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Caldova Careers should model maintainable code for workshop learners. Add lightweight standards for comments, exported functions, and component props, then apply them to the existing codebase.
Acceptance criteria
- Comments explain intent or constraints, not mechanics that are obvious from the code.
- Exported functions in
db/andsrc/lib/have useful TSDoc. -
.astrocomponents with props document theirPropsshape. - The README links to the coding standards.
- Existing code is updated where it falls short of the standards.
-
npm run lintpasses.
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 the existing code in db/, src/lib/, and the .astro components, then inspect the README and run npm run lint. Define the coding standards from the acceptance criteria, document them, link them from the README, and update existing comments, exported functions, and component Props documentation until lint passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100