{"id":22306278,"url":"https://github.com/blackxored/commitlint-config-conventional-system","last_synced_at":"2026-01-29T11:37:18.102Z","repository":{"id":46937231,"uuid":"114698591","full_name":"blackxored/commitlint-config-conventional-system","owner":"blackxored","description":"Commitlint config for conventional system extensions for scopes and more","archived":false,"fork":false,"pushed_at":"2022-12-07T09:29:37.000Z","size":911,"stargazers_count":3,"open_issues_count":32,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T01:13:28.862Z","etag":null,"topics":["commitlint","commitlint-config","conventional-commits"],"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/blackxored.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-18T23:42:10.000Z","updated_at":"2024-10-30T01:00:29.000Z","dependencies_parsed_at":"2023-01-24T16:31:05.818Z","dependency_job_id":null,"html_url":"https://github.com/blackxored/commitlint-config-conventional-system","commit_stats":null,"previous_names":["blackxored/commitlint-config-conventional-system","xoredg/commitlint-config-conventional-system"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackxored%2Fcommitlint-config-conventional-system","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackxored%2Fcommitlint-config-conventional-system/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackxored%2Fcommitlint-config-conventional-system/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackxored%2Fcommitlint-config-conventional-system/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blackxored","download_url":"https://codeload.github.com/blackxored/commitlint-config-conventional-system/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248525153,"owners_count":21118616,"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":["commitlint","commitlint-config","conventional-commits"],"created_at":"2024-12-03T19:15:11.980Z","updated_at":"2026-01-29T11:37:13.035Z","avatar_url":"https://github.com/blackxored.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# commitlint-config-conventional-system\n\n\u003e Commitlint config for conventional system extensions for scopes and more\n\n[![Semantically Released][semantic-release-badge]][semantic-release]\n[![Build Status][build-badge]][build]\n[![Code Coverage][coverage-badge]][coverage]\n[![version][version-badge]][package]\n[![downloads][downloads-badge]][npmtrends]\n[![Styled with Prettier][prettier-badge]][prettier]\n[![AirBnB style guide][airbnb-style-badge]][airbnb-style]\n\n[![MIT License][license-badge]][LICENSE]\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)\n[![PRs Welcome][prs-badge]][prs]\n[![Commitizen friendly][commitizen-badge]][commitizen]\n[![Code of Conduct][coc-badge]][coc]\n\n[![Watch on GitHub][github-watch-badge]][github-watch]\n[![Star on GitHub][github-star-badge]][github-star]\n[![Tweet][twitter-badge]][twitter]\n\ncommitlint configuration for system and apps with defined scopes, commit types and more.\nBy defining standard components of a system or app and using them as scopes, plus adding a few\nrelated to commit types, we ensure consistency across our projects.\n\nThese are scopes that should be common in most systems, we call these components:\n\n* **auth:** Authentication, login, OAuth, etc.\n* **forms:** General user input, forms, etc.\n* **navigation:** Navigation, history and routing.\n* **networking\":** Network-related code, connectivity checks, offline persistence, etc.\n* **notifications:** Notification code, in-app notifications, push notifications, etc.\n* **profile:** User profile, friends, followers, etc.\n* **settings:** Settings and preferences.\n* **system**: A general catch-all, for changes that impact many areas of the system.\n\nWe define 4 scopes you can use if you're interested in highlighted which platform\nis affected by the changes:\n\n* **core**: Shared code.\n* **native**: Mobile platforms.\n* **desktop**: Desktop platforms.\n* **web**: Web platforms.\n\nAnd finally, we define general scopes that refer to the nature of the change:\n\n* build\n* deps\n* packaging\n* release\n\nBut more importantly, we allow you to customize these.\n`system` refers to the above. You can include your packages in the `packages`\nsection, and you can customize your `components`, along with descriptions.\n\n\n## Installing / Getting Started\n\nCreate a `.commitlint-patterns.json` at the root of your respository.\nSee `examples/commitlint-pattern.json`.\n\nExtend your config with this one. In `commitlint.config.js`:\n\n```javascript\nmodule.exports = {\n  extends: ['config-conventional-system']\n}\n```\n\n### Prerequisites\n\n* commitlint\n\n## Developing\n\n### Built With\n\n* Ramda\n\n### Setting up Dev\n\nHere's a brief intro about what a developer must do in order to start \ndeveloping the project further:\n\n```shell\ngit clone https://github.com/blackxored/commitlint-config-conventional-system\ncd commitlint-config-conventional-system\nyarn\n```\n\nAnd state what happens step-by-step. If there is any virtual environment, \nlocal server or database feeder needed, explain here.\n\n## Versioning\n\nWe use [SemVer][semver] for versioning. In addition, it's automatic via\n[semantic-release][semantic-release], and our [commit convention][commit-convention].\n\nFor the versions available, see the [Releases][releases] on this repository.\n\n## Configuration\n\nHere you should write what are all of the configurations a user can enter when\nusing the project.\n\n## Tests\n\n```shell\nyarn test\n```\n\n## Style guide\n\nWe base our code style on [AirBnB's style guide][airbnb-style] and we check with \n[ESLint][eslint] and automatically format our code with [Prettier][prettier].\n\n## License\n\nThis project is licensed under the MIT License - see the \n[license] file for details.\n\n## Contributing\n\nIf you're interested in contributing to this project in any form, please read\nour [Contribution Guidelines][contributing].\n\n### Code of Conduct\n\nWe've adopted a Code of Conduct that we expect project participants to adhere to.\nPlease read the [full text][coc] so that you can understand what actions \nwill and will not be tolerated.\n\n### Contributors\n\nThanks goes to these people ([emoji key][emojis]):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore --\u003e\n| [\u003cimg src=\"https://avatars3.githubusercontent.com/u/133308?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAdrian Perez\u003c/b\u003e\u003c/sub\u003e](https://adrianperez.codes)\u003cbr /\u003e[💻](https://github.com/blackxored/commitlint-config-conventional-system/commits?author=blackxored \"Code\") [📖](https://github.com/blackxored/commitlint-config-conventional-system/commits?author=blackxored \"Documentation\") [🚇](#infra-blackxored \"Infrastructure (Hosting, Build-Tools, etc)\") [⚠️](https://github.com/blackxored/commitlint-config-conventional-system/commits?author=blackxored \"Tests\") |\n| :---: |\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors][all-contributors] specification.\nContributions of any kind welcome!\n\n\n[npm]: https://www.npmjs.com/\n[node]: https://nodejs.org\n[build-badge]: https://img.shields.io/travis/blackxored/commitlint-config-conventional-system.svg?style=flat-square\n[build]: https://travis-ci.org/blackxored/commitlint-config-conventional-system\n[coverage-badge]: https://img.shields.io/codecov/c/github/blackxored/commitlint-config-conventional-system.svg?style=flat-square\n[coverage]: https://codecov.io/github/blackxored/commitlint-config-conventional-system\n[version-badge]: https://img.shields.io/npm/v/commitlint-config-conventional-system.svg?style=flat-square\n[package]: https://www.npmjs.com/package/commitlint-config-conventional-system\n[downloads-badge]: https://img.shields.io/npm/dm/commitlint-config-conventional-system.svg?style=flat-square\n[npmtrends]: http://www.npmtrends.com/commitlint-config-conventional-system\n[license-badge]: https://img.shields.io/npm/l/commitlint-config-conventional-system.svg?style=flat-square\n[license]: https://github.com/blackxored/commitlint-config-conventional-system/blob/master/LICENSE.md\n[semantic-release]: https://github.com/semantic-release/semantic-release\n[semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square\n[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square\n[commitizen]: http://commitizen.github.io/cz-cli/\n[prettier-badge]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square\n[prettier]: https://github.com/prettier/prettier \n[airbnb-style-badge]: https://img.shields.io/badge/code%20style-airbnb-green.svg?style=flat-square\n[airbnb-style]: https://github.com/airbnb/javascript\n[eslint]: http://eslint.org \n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs]: http://makeapullrequest.com\n[donate-badge]: https://img.shields.io/badge/$-support-green.svg?style=flat-square\n[contributing]: https://github.com/blackxored/commitlint-config-conventional-system/blob/master/CONTRIBUTING.md\n[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square\n[coc]: https://github.com/blackxored/commitlint-config-conventional-system/blob/master/CODE_OF_CONDUCT.md\n[github-watch-badge]: https://img.shields.io/github/watchers/blackxored/commitlint-config-conventional-system.svg?style=social\n[github-watch]: https://github.com/blackxored/commitlint-config-conventional-system/watchers\n[github-star-badge]: https://img.shields.io/github/stars/blackxored/commitlint-config-conventional-system.svg?style=social\n[github-star]: https://github.com/blackxored/commitlint-config-conventional-system/stargazers\n[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20commitlint-config-conventional-system%20by%20%40blackxored%20https%3A%2F%2Fgithub.com%2Fblackxored%2Fcommitlint-config-conventional-system%20%F0%9F%91%8D\n[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/blackxored/commitlint-config-conventional-system.svg?style=social\n[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key\n[all-contributors]: https://github.com/kentcdodds/all-contributors\n[semver]: http://semver.org/\n[releases]: https://github.com/blackxored/commitlint-config-conventional-system/releases\n[commit-convention]: https://www.npmjs.com/package/@commitlint/config-conventional\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackxored%2Fcommitlint-config-conventional-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblackxored%2Fcommitlint-config-conventional-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackxored%2Fcommitlint-config-conventional-system/lists"}