Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (37 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 1.53 KB

Contributing to LDE

Thanks for your interest in contributing to LDE! This guide will help you get started.

Getting started

git clone https://github.com/ldelements/lde.git
cd lde
npm install

Development workflow

LDE is an Nx monorepo. Use Nx to run tasks for individual packages or the entire workspace:

npx nx build <package>        # build a single package
npx nx test <package>         # run tests for a single package (Vitest)
npx nx lint <package>         # lint a single package
npx nx typecheck <package>    # type-check a single package
npx nx run-many -t build      # build everything
npx nx run-many -t test       # test everything

To run tasks only for packages affected by your changes:

npx nx affected -t lint test typecheck build

Code style

  • TypeScript in strict mode with ESNext modules.
  • ESLint and Prettier run automatically via pre-commit hooks (lint-staged + Husky). You normally don’t need to run them manually.
  • Conventional commits — prefix your commit messages with a type (feat:, fix:, chore:, etc.). This drives automated versioning.

Submitting changes

  1. Fork the repository and create a feature branch from main.
  2. Make your changes, ensuring npx nx affected -t lint test typecheck build passes.
  3. Commit using conventional commits.
  4. Open a pull request against main.

Licence

By contributing you agree that your contributions will be licensed under the MIT License.