GeekTrainer / GeekTrainer/issue-tester
Update our repository coding standards
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Clear, documented coding standards keep the codebase consistent and make it easier for new contributors (and Copilot) to produce correct changes. We need to refresh our standards to cover TypeScript formatting rules and docstring/comment expectations so that frontend and backend code follow a single, well-understood convention.
Acceptance criteria
- TypeScript formatting rules are documented and, where possible, enforced through ESLint
- Docstring and comment expectations are documented for both Python and TypeScript
- The relevant
.github/instructionsfiles are updated to reflect the standards - The README links to or summarizes the updated coding standards
-
scripts/run-lint.shpasses with any newly added rules
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
Review the relevant .github/instructions files, the README, and scripts/run-lint.sh to understand the existing standards and lint workflow. Document TypeScript formatting plus Python and TypeScript docstring/comment expectations, update the instruction files, and link to or summarize the standards in the README. Run scripts/run-lint.sh and confirm it passes with any added rules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, python, typescript
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100