Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (64 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

87 lines (64 loc) · 2.34 KB

Contributing to ASCIIGround

Commit message format

This project follows Conventional Commits specification. All commit messages should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types

  • feat - a new feature.
  • fix - a bug fix.
  • docs - documentation only changes.
  • style - changes that do not affect the meaning of the code.
  • refactor - a code change that neither fixes a bug nor adds a feature.
  • perf - a code change that improves performance.
  • test - adding missing tests or correcting existing tests.
  • chore - changes to the build process or auxiliary tools.
  • revert - reverting a previous commit.
  • build - changes that affect the build system or external dependencies.
  • ci - changes to our CI configuration files and scripts.

Examples

feat: add wave pattern animation
fix: resolve memory leak in canvas cleanup
docs: update installation instructions
style: fix linting issues in src/index.ts
refactor: simplify noise generation algorithm
test: add unit tests for pattern switching
chore: update dependencies to latest versions
ci: configure GitHub Actions for CI
build: update Vite configuration for production build
revert: revert "feat: add wave pattern animation"
perf: optimize rendering loop

Breaking changes

For breaking changes, add ! after the type/scope and include BREAKING CHANGE: in the footer:

feat!: change pattern API signature

BREAKING CHANGE: Pattern constructor now requires options object instead of individual parameters

Using commitizen

To help create properly formatted commits, you can use commitizen:

npm run commit

This will guide you through creating a conventional commit message.

Development workflow

  1. Make your changes.
  2. Run tests: npm run test:run.
  3. Build the library: npm run build.
  4. Commit using: npm run commit.
  5. Create a pull request.

Release process

Releases are automated via GitHub Actions. To create a new release:

  1. Go to the repository's Actions tab.
  2. Run the "Version bump and release" workflow.
  3. Choose the appropriate version bump type (patch/minor/major).

This will:

  • Run all tests.
  • Bump the version.
  • Generate a changelog.
  • Create a GitHub release.
  • Publish to NPM.
  • Deploy to CDN.