Version Control & Automation

This category covers files related to Git, commit standards, and automated release processes.

.commitlint

This file enforces Conventional Commits for structured commit messages.

  • Ensures clear commit history for semantic releases.

  • Add custom commit types or adjust rules like header length.

.gitignore

This file specifies files/folders Git should ignore.

  • Prevents committing sensitive files like .env or node_modules/.

  • Include project-specific ignores like logs or temp files.

.release.config.js

This file configures Semantic Release for automated versioning.

  • Automates releases and changelogs using commit messages.

  • Add plugins for npm publishing or custom release assets.

.github

This folder contains GitHub-specific configurations, primarily for workflows and automation.

  • Holds GitHub Actions workflows to automate tasks like CI/CD pipelines. Currently, the only action implemented is for semantic releases, which automates versioning and changelog generation based on commit messages.

  • You can expand this by adding more workflows, such as for automated testing, deployment to Vercel/AWS, or linting checks. For example, integrate actions for pull request reviews or security scans to fit your project's scale.

How is this guide ?

Last updated on