Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (42 loc) · 1009 Bytes

CONTRIBUTING.md

File metadata and controls

57 lines (42 loc) · 1009 Bytes

Contributing

Development

  1. Install dependencies:

    npm install

  2. Make your changes in scripts/

  3. Build:

    npm run build

  4. Test locally by creating a PR in this repo

  5. Commit both scripts/ and dist/:

    git add scripts/ dist/
git commit -m "Your changes"

Release Process

  1. Build:

    npm run build
git add dist/
git commit -m "Build for release"

  2. Tag and push:

    git tag -a v1.0.1 -m "Release v1.0.1: Description"
git push origin v1.0.1

# Update major version tag
git tag -f v1 -m "Release v1"
git push -f origin v1

  3. Create GitHub Release (optional)

Versioning

  • Major (v2.0.0): Breaking changes
  • Minor (v1.1.0): New features, backward compatible
  • Patch (v1.0.1): Bug fixes

Important

  • Always run npm run build before committing
  • The dist/ folder must be committed
  • Use modern JavaScript (Node 20+)
  • Add comments for complex logic