docs: expand CONTRIBUTING.md with code quality standards#447
Open
sonukapoor wants to merge 1 commit into
Open
Conversation
Add named constants, DRY, single responsibility, braces on conditionals, and formatting sections to the coding standards. Closes #445
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
src/constants.tssrc/index.tsstays a thin orchestration layer; new output formats get their own moduleif/else/for/whileblocks require bracesnpm run formatand the forthcoming Prettier setup (chore: add Prettier for consistent code formatting #446)