{"id":21175333,"url":"https://github.com/murcegany/commit-standardization-guide","last_synced_at":"2026-03-27T02:40:33.893Z","repository":{"id":263637995,"uuid":"851838127","full_name":"Murcegany/Commit-Standardization-Guide","owner":"Murcegany","description":"This repository is a guide to help developers standardize their commit messages using the Conventional Commits design.","archived":false,"fork":false,"pushed_at":"2024-11-19T15:53:28.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-01T04:22:19.534Z","etag":null,"topics":["command-line","commit"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Murcegany.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-03T19:29:22.000Z","updated_at":"2024-11-19T15:53:43.000Z","dependencies_parsed_at":"2024-11-19T16:50:12.887Z","dependency_job_id":null,"html_url":"https://github.com/Murcegany/Commit-Standardization-Guide","commit_stats":null,"previous_names":["murcegany/commit-standardization-guide"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Murcegany/Commit-Standardization-Guide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Murcegany%2FCommit-Standardization-Guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Murcegany%2FCommit-Standardization-Guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Murcegany%2FCommit-Standardization-Guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Murcegany%2FCommit-Standardization-Guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Murcegany","download_url":"https://codeload.github.com/Murcegany/Commit-Standardization-Guide/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Murcegany%2FCommit-Standardization-Guide/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31011255,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-27T02:33:22.146Z","status":"ssl_error","status_checked_at":"2026-03-27T02:33:21.763Z","response_time":164,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","commit"],"created_at":"2024-11-20T16:59:05.061Z","updated_at":"2026-03-27T02:40:33.861Z","avatar_url":"https://github.com/Murcegany.png","language":null,"readme":"# Commit Standardization Guide \nThis repository is a guide to help developers standardize their commit messages using the Conventional Commits concept.\n\n## Why Standardize Commits?\n- Understand the change history.\n- Automate versioning and changelogs.\n- Collaborate with other developers more effectively.\n\n## Why Standardize Commits?\n- Introduction: Why standardizing commits is important.\n- Configuration: How to configure tools like Husky and Commitlint.\n- Examples: Practical examples of standardized commits.\n- Advanced: Automation and hooks to ensure the quality of commit messages.\n\n## Configuration\n\n1. Install the required packages:\n\n```bash\nnpm install husky @commitlint/config-conventional @commitlint/cli --save-dev\n```\n\n2. Configure Husky:\n\n```bash\nnpx husky install\n```\n\n3. Create a Commitlint configuration file called .commitlintrc.json:\n\n```bash\n{\n\"extends\": [\"@commitlint/config-conventional\"]\n}\n```\n\n4. Add a Husky hook to ensure commit messages are in the correct format:\n\n```bash\nnpx husky add .husky/commit-msg 'npx --no-install commitlint --edit \"$1\"'\n```\n\n## Commit types\n\n| Type | Description | Commit Example |\n|------------|----------------------------------------------------------------|--------------------------------------------------|\n| `feat` | Adding new functionality | `feat: implement user profile page` |\n| `fix` | Bug fix | `fix: resolve login page crash issue` |\n| `docs` | Documentation change | `docs: update README with setup instructions` |\n| `style` | Change that does not affect the code (only formatting) | `style: format code according to linting rules` |\n| `refactor` | Refactoring the code without adding functionality | `refactor: improve performance of user data processing` |\n| `test` | Adding or modifying tests | `test: add unit tests for login functionality` |\n| `chore` | General updates and maintenance | `chore: update dependencies` |\n| `perf` | Performance-improving code changes | `perf: optimize image loading time` |\n| `ci` | Continuous integration (CI) configuration changes | `ci: add GitHub Actions for automated testing` |\n| `build` | Changes affecting the build system or external dependencies | `build: upgrade Node.js to version 14` |\n| `revert` | Reverting a previous commit | `revert: undo commit 1234abcd` |\n| `hotfix` | Urgent bug fix in production | `hotfix: fix critical bug in payment processing` |\n| `security` | Security fixes | `security: patch vulnerability in user login` |\n| `env` | Changes to the environment or environment variables | `env: update environment variables for staging` |\n| `config` | Changes to configuration files or tools | `config: update eslint configuration` |\n| `merge` | Merging changes from another branch | `merge: merge feature branch into main` |\n| `upgrade` | Upgrading dependencies or tools | `upgrade: upgrade version`\n| `dev` | Changes to development tools or environment settings | `dev: update local dev environment setup` |\n| `wip` | Work in progress  | `wip: draft new feature for user profile` |\n| `ui` | Changes to user interface elements | `ui: update button style on login page` |\n| `db` | Changes related to database structure or migrations | `db: add 'name' column to users table` |\n| `api` | Changes related to API (new endpoints, updates) | `api: add endpoint to fetch user preferences` |\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmurcegany%2Fcommit-standardization-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmurcegany%2Fcommit-standardization-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmurcegany%2Fcommit-standardization-guide/lists"}