Skip to content

docs: expand CONTRIBUTING.md with code quality standards#447

Open
sonukapoor wants to merge 1 commit into
mainfrom
docs/issue-445-contributing-code-quality
Open

docs: expand CONTRIBUTING.md with code quality standards#447
sonukapoor wants to merge 1 commit into
mainfrom
docs/issue-445-contributing-code-quality

Conversation

@sonukapoor
Copy link
Copy Markdown
Collaborator

Closes #445

Expands the coding standards section with the practices we enforce during review but hadn't written down yet. Gives contributors a clear reference before they open a PR.

Added sections:

  • Named constants — magic strings and numbers must be extracted to src/constants.ts
  • DRY — repeated logic belongs in a shared utility, not copied across files
  • File size and single responsibility — keep files focused; src/index.ts stays a thin orchestration layer; new output formats get their own module
  • Braces on conditionals — all if/else/for/while blocks require braces
  • Formatting — references npm run format and the forthcoming Prettier setup (chore: add Prettier for consistent code formatting #446)

Add named constants, DRY, single responsibility, braces on conditionals,
and formatting sections to the coding standards.

Closes #445
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: expand CONTRIBUTING.md with code quality standards

1 participant