Skip to content

docs: fix typescript guidelines & add explicit prettier config#109

Open
aaronstrachardt wants to merge 2 commits into
Workflomics:mainfrom
aaronstrachardt:fix/docs-and-indentation
Open

docs: fix typescript guidelines & add explicit prettier config#109
aaronstrachardt wants to merge 2 commits into
Workflomics:mainfrom
aaronstrachardt:fix/docs-and-indentation

Conversation

@aaronstrachardt

@aaronstrachardt aaronstrachardt commented Dec 12, 2025

Copy link
Copy Markdown

Overview

This PR addresses an inconsistency between the documented TypeScript guidelines and the actual codebase style. It updates the CONTRIBUTING.md to reflect the projects use of 2-space indentation and adds a .prettierrc config file to enforce these rules, preventing confusion for new contributors.

Changes

  1. Updated CONTRIBUTING.md:
  • Removed the link to the Microsoft TypeScript Coding Guidelines which incorrectly says that you should use 4 space indentation and forbids the use of classes
  1. Added .prettierrc:
  • Created a config file with 2-space indentation, no trailing commas, etc. that try to match the existing code style

Checklist

  • Code follows project standards.
  • Self-reviewed and commented where needed.
  • Documentation updated if needed.
  • No new warnings or errors.

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.

1 participant