{"id":22096488,"url":"https://github.com/uphold/commitlint-config-uphold","last_synced_at":"2025-07-24T22:32:04.430Z","repository":{"id":39618517,"uuid":"495365337","full_name":"uphold/commitlint-config-uphold","owner":"uphold","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-19T13:43:00.000Z","size":420,"stargazers_count":1,"open_issues_count":5,"forks_count":1,"subscribers_count":37,"default_branch":"master","last_synced_at":"2024-11-21T20:48:30.547Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/uphold.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2022-05-23T10:39:03.000Z","updated_at":"2024-09-19T13:42:55.000Z","dependencies_parsed_at":"2024-06-21T20:30:18.854Z","dependency_job_id":"d4fa0764-e1bc-4912-9cd6-4d14b54ed7ab","html_url":"https://github.com/uphold/commitlint-config-uphold","commit_stats":{"total_commits":11,"total_committers":2,"mean_commits":5.5,"dds":0.09090909090909094,"last_synced_commit":"d1100e3d68bda32b46d8594e114dea5eb083a26a"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fcommitlint-config-uphold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fcommitlint-config-uphold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fcommitlint-config-uphold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fcommitlint-config-uphold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uphold","download_url":"https://codeload.github.com/uphold/commitlint-config-uphold/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227482486,"owners_count":17779968,"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-12-01T04:11:12.909Z","updated_at":"2024-12-01T04:11:13.401Z","avatar_url":"https://github.com/uphold.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @uphold/commitlint-config-uphold\n\nShareable commitlint config enforcing Uphold's commit conventions.\n\n## Status\n\n[![npm version][npm-image]][npm-url]\n[![build status][ci-image]][ci-url]\n\n## Motivation\n\nThis package ensures our commits follow our standard:\n\n1. Header must not exceed 72 characters.\n1. Header must start with a verb in the simple present tense (imperative mood).\n1. Header must be sentence-cased, meaning it must start with an uppercase letter.\n1. Header must not end with a full-stop.\n1. Body can make use of all verb tenses.\n\n## Installation\n\n```sh\n❯ npm i @uphold/commitlint-config-uphold --save-dev\n```\n\nor with Yarn:\n\n```sh\n❯ yarn add commitlint-config-uphold --dev\n```\n\n### Usage with [commitlint](https://commitlint.js.org/)\n\nCreate `.commitlintrc.yml` with:\n\n```yml\nextends: \"@uphold/commitlint-config\"\n```\n\n## Verbs detection\n\nVerbs are detected using data from [Wordnet](https://wordnet.princeton.edu/) provided by [wordnet](https://www.npmjs.com/package/wordnet) package.\n\nThe `wordnet` database is large with more than 28 megabytes because it contains all the english words, including their definitions. To provide the smallest package possible, there's a script that generates a JSON file that contains the extracted english verbs from `wordnet`. To update the generated JSON whenever `wordnet` releases a new version, run:\n\n```sh\n❯ yarn update-wordnet-verbs\n```\n\n\u003e ⚠️ The detection algorithm simply checks if the first word is an english word that may be used as a verb (in the simple-present tense). It does not account if the word is actually a verb in the context of the phrase. It would be possible to detect if it's actually used as a verb by using natural language processing techniques. However, they often give bad results.\n\n## License\n\n[MIT](https://opensource.org/licenses/MIT)\n\n[npm-image]: https://img.shields.io/npm/v/@uphold/commitlint-config.svg\n[npm-url]: https://www.npmjs.com/package/@uphold/commitlint-config\n[ci-image]: https://github.com/uphold/commitlint-config-uphold/actions/workflows/ci.yml/badge.svg?branch=master\n[ci-url]: https://github.com/uphold/commitlint-config-uphold/actions/workflows/ci.yml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuphold%2Fcommitlint-config-uphold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuphold%2Fcommitlint-config-uphold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuphold%2Fcommitlint-config-uphold/lists"}