Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (49 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

77 lines (49 loc) · 1.45 KB

Contributing

Setup

Prerequisites:

Make sure to install dependencies:

npm install

Development

Refer to docs on how to run tasks in Nx.

Some examples:

# visualize project graph
npx nx graph

# run tests for all projects
npx nx run-many -t test

# run tests for a specific project
npx nx run eslint-config:test

# run lint for all projects
npx nx run-many -t lint

# run type check for all projects
npx nx run-many -t typecheck

# check formatting
npx nx format:check

# fix formatting
npx nx format:write

# generate docs for eslint-config
npx nx run eslint-config:docs

Commits

This repository uses conventional commits. Commit messages are linted with Commitlint and must follow the format:

type(scope): description

Valid scopes correspond to Nx project names (e.g. eslint-config, create-eslint-config).

You can use Commitizen to create commits interactively:

npm run commit

Releases

Releases are managed with Nx release. Both packages are published together under the same version (fixed releases).

To create a release manually:

npx nx release

To preview a release without making changes:

npx nx release --dry-run