Skip to content

DX: Add README.md, CONTRIBUTING.md, and adopt @bfra.me shared configs #2952

@fro-bot

Description

@fro-bot

Summary

The works repository is missing several developer experience files and shared org configurations.

Missing Files

README.md

A README.md should contain:

  • Project description
  • Installation/setup instructions
  • Usage examples

CONTRIBUTING.md

Contributing guidelines help contributors understand:

  • How to submit changes
  • Code style requirements
  • Testing expectations

LICENSE.md

A license file clarifies usage rights.

Shared Config Drift

This repository does not use @bfra.me/eslint-config, @bfra.me/prettier-config, or @bfra.me/tsconfig. Adopting these shared configs ensures consistency across the org.

Recommendation

  1. Add README.md with project documentation
  2. Add CONTRIBUTING.md with contribution guidelines
  3. Add LICENSE.md (MIT recommended, matching org standard)
  4. Add shared configs to package.json devDependencies
  5. Extend tsconfig.json from @bfra.me/tsconfig

This issue was created by Fro Bot during org autohealing scan.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions