{"id":19312130,"url":"https://github.com/bigcommerce/validate-commits","last_synced_at":"2025-04-22T15:31:59.246Z","repository":{"id":33154197,"uuid":"104709238","full_name":"bigcommerce/validate-commits","owner":"bigcommerce","description":"Commit message validator","archived":false,"fork":false,"pushed_at":"2024-01-15T07:00:38.000Z","size":981,"stargazers_count":4,"open_issues_count":1,"forks_count":7,"subscribers_count":80,"default_branch":"master","last_synced_at":"2024-09-19T07:09:32.345Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/bigcommerce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2017-09-25T06:03:09.000Z","updated_at":"2023-09-24T15:32:03.000Z","dependencies_parsed_at":"2024-06-18T21:30:40.079Z","dependency_job_id":"26847d10-0f72-4a96-adac-1a3d3ce251d9","html_url":"https://github.com/bigcommerce/validate-commits","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fvalidate-commits","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fvalidate-commits/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fvalidate-commits/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fvalidate-commits/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigcommerce","download_url":"https://codeload.github.com/bigcommerce/validate-commits/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223900371,"owners_count":17222028,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-10T00:32:59.739Z","updated_at":"2024-11-10T00:32:59.839Z","avatar_url":"https://github.com/bigcommerce.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @bigcommerce/validate-commits\n\nThis is a tool for validating commit messages - to ensure they have a consistent format and the required information.\n\n## Installation\n\n```sh\nnpm install --save-dev @bigcommerce/validate-commits\n```\n\n## Usage\n\nYour commit message needs to have the following format:\n\n```\ntask(scope): JIRA-1234 My commit message\n```\n\nYou might also want to include a message body to provide additional information, for example, a breaking change.\n\n```\ntask(scope): JIRA-1234 My commit message\n\nBREAKING CHANGE: ABC has been renamed to XYZ.\n```\n\n### Tasks\n\nBelow is a list of supported tasks:\n\n* **feat**: A new feature\n* **fix**: A bug fix\n* **docs**: Documentation only changes\n* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)\n* **refactor**: A code change that neither fixes a bug nor adds a feature\n* **perf**: A code change that improves performance\n* **test**: Adding missing or correcting existing tests\n* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation\n\n### Scopes\n\nYou need to add `commit-validation.json` to the root of your project in order to configure a list of supported scopes. i.e.:\n\n```json\n{\n    \"scopes\": [\n        \"payment\",\n        \"checkout\",\n        \"orders\"\n    ]\n}\n```\n\n### CLI\n\nTo run the validator in Terminal:\n\n```sh\nnpx validate-commits\n```\n\n## Requirements\n\n* Node: `\u003e=18`\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fvalidate-commits","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigcommerce%2Fvalidate-commits","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fvalidate-commits/lists"}