Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 1006 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1006 Bytes

Contributing to CodeType

Thanks for helping improve CodeType.

Ground Rules

  • Follow CODE_OF_CONDUCT.md
  • Keep changes focused; open an issue or discussion for big shifts

Repo Layout

  • codetype-vscode/ - VS Code extension
  • codetype-backend/ - Cloudflare Worker API
  • codetype-website/ - Eleventy site

See each component README for setup, tests, and release steps:

  • codetype-vscode/README.md
  • codetype-backend/README.md
  • codetype-website/README.md

Pull Requests

  1. Create a branch.
  2. Make changes with tests or note why tests do not apply.
  3. Run relevant scripts (lint/tests/build) for the component you touched.
  4. Update docs or codetype-vscode/CHANGELOG.md when behavior changes.
  5. Open a PR with a clear summary and screenshots for UI updates.

Commit Style

Use clear, scoped messages. Conventional Commits are preferred.

Questions