Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (15 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 1.56 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Creating an issue for a feature request is also acceptable. For smaller fixes, additions, or changes a simple fork and pull request is sufficient.

Please note we have a code of conduct; please follow it in all your interactions with the project.

Branching and Pull Requests

  1. Fork the repository and create a new branch from main with a descriptive name (e.g. feat/block-validation or fix/typo-in-readme).
  2. Make your changes, following the Style Guide.
  3. Add or update tests for any code you change (see the Testing section below).
  4. Run npm run lint and npm test to confirm everything passes before opening a PR.
  5. Submit a pull request against main with a clear title and description. Reference any related issues.

Testing

  • Tests live in the test/ folder of each package and mirror the src/ structure.
  • Run all tests from the repo root with npm test.
  • When adding tests that call functions expecting a DocumentDiagnosticsBuilder, use TestDiagnoser.createDocument rather than TestDiagnoser.create.

Contributing Features

Looking to add diagnostics, autocompletions, or custom type definitions? See the Contributing Features Guide for a step-by-step workflow covering setup, implementation, testing, and submitting a pull request.