Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (42 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 1.37 KB

Contribution Guide

Local development notcms-kit

cd packages/notcms-kit

# if first time, you may need to run also:
# pnpm config set prefix ~/.pnpm-global
pnpm link --global

# watch the changes while you code
pnpm watch

In case you want to remove from global

pnpm remove --global notcms-kit

Make sure to check before submitting a PR.

pnpm check

Changesets (Version Management)

This project uses Changesets for version management and changelog generation.

All pull requests must include a changeset.

How to add a changeset

  1. After making your changes, run:

    pnpm changeset

  2. Select the packages being changed (use spacebar to select, enter to confirm)

  3. Choose the version bump type:

    • patch - Bug fixes, minor improvements
    • minor - New features (backwards compatible)
    • major - Breaking changes

  4. Write a brief description of your changes (this will appear in the CHANGELOG)

  5. Commit the generated changeset file along with your changes:

    git add .changeset/
git commit -m "chore: add changeset"

Release Process

When changes with changesets are merged to main:

  1. A "Version Packages" PR is automatically created
  2. This PR updates versions and CHANGELOGs
  3. When merged, packages are automatically published to npm