{"id":15657239,"url":"https://github.com/khattakdev/minimalcommit","last_synced_at":"2025-10-09T10:12:22.362Z","repository":{"id":150317409,"uuid":"622102678","full_name":"khattakdev/minimalcommit","owner":"khattakdev","description":"A minimalist approach toward git commits to keep commits simple.","archived":false,"fork":false,"pushed_at":"2023-10-31T19:41:51.000Z","size":37,"stargazers_count":42,"open_issues_count":8,"forks_count":9,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-01T13:35:32.348Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/khattakdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2023-04-01T05:58:17.000Z","updated_at":"2025-04-09T15:00:19.000Z","dependencies_parsed_at":"2023-10-16T08:20:54.481Z","dependency_job_id":"4cba5eae-5fca-4491-a224-0580ab5334be","html_url":"https://github.com/khattakdev/minimalcommit","commit_stats":{"total_commits":19,"total_committers":5,"mean_commits":3.8,"dds":0.3157894736842105,"last_synced_commit":"3f1e93f6ec4d370afcdaf2dfe7806369edf9f8d0"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/khattakdev/minimalcommit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khattakdev%2Fminimalcommit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khattakdev%2Fminimalcommit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khattakdev%2Fminimalcommit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khattakdev%2Fminimalcommit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khattakdev","download_url":"https://codeload.github.com/khattakdev/minimalcommit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khattakdev%2Fminimalcommit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001323,"owners_count":26083040,"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","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["hacktoberfest"],"created_at":"2024-10-03T13:06:00.231Z","updated_at":"2025-10-09T10:12:22.348Z","avatar_url":"https://github.com/khattakdev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Minimal Commit\n\n\u003e _A minimalist approach toward `git commit` to keep commits simple._\n\n![Minimal Commit Image](https://github.com/Haimantika/minimalcommit/assets/32809211/133f42ad-3483-46ee-9bdf-f29a06356737)\n\n\n## What is Minimal Commit?\n\nMinimal commit is a Node.js based CLI (command line interface) tool that helps you and your team mates to stay consistent with the `git commit` messages. To commit files using **Minimal Commit**, you have a list of options to choose from, this list consist type of work you did. This makes things simple and less confusing by choosing an option from a list.\n\nThe list of options is limited to only **nine types**. This is done on purpose to keep the list as short as possible to avoid confusion. The more options you have, the more confusing it will be.\n\n## Types\nFollowing are the nine types of commits.\n- `✨ feat` to be used for a new feature\n- `🐛 fix` to be used for bug fixes\n- `💥 break` to be used for breaking changes\n- `♻️ ref` to be used for making code/folder refactor\n- `🧪 test` to be used for writing test cases\n- `🔖 ver` to be used for version changes\n- `📝 docs` to be used for documentation\n- `🎨 style` to be used for CSS changes\n- `🛠 config` for configuration, and dependencies changes\n- `📦 misc` to be used for others\n\n## Installation\n\nTo install **Minimal Commit**, you can use the following command.\n\n```\nnpm install -g minimalcommit\n```\n\n## Why Minimal Commit?\n\n- Straight Forward\n- Easy to read\n- Visually appealing\n\n## Usage\n```\nmct\n```\n\n![Minimal Commit demo](https://user-images.githubusercontent.com/37709578/229569956-592effaa-63e6-4f15-8870-6c5f9061f19f.gif)\n\n\n## How to write commits?\n\nHere’s the general syntax of Minimal Commit.\n\n```\n\u003ctype\u003e: \u003cmessage\u003e\n```\n\n\u003e ⚠️ All of the commits must be written in the present tense.\n\u003e Following are some examples:\n\n```\n✨ feat: added sign-up feature ❌\n✨ feat: add sign up feature ✅\n\n🛠 config: removed extra extension files ❌\n🛠 config: remove extra extension files ✅\n```\n\nThe commit title should be precise, and to the point but at the same time, it shouldn't be vague. All of the extra details should go in the description (_⚠️ Descriptions are not supported yet_.)\n\n```\n✨ feat: add new feature ❌\n✨ feat: add sign up feature with forgot password and auth with Google ❌\n✨ feat: add sign up feature using OAuth ✅\n✨ feat: add sign up feature ✅\n```\n\nFollowing are some more examples:\n\n```\n🛠 config: add .gitignore file\n♻️ ref: move functions to helper.js\n📦 misc: add initial test cases\n📦 docs: update docs with v2.0 features\n```\n\n### Examples\n\n- You added `.yaml` file for GitHub Actions\n\n`✨ config: add .yaml file for github actions`\n\n- You added some tests cases for the user interface\n\n`📦 misc: add test cases for ui`\n\n- You moved some part of the code to components folder\n\n`♻️ ref: move pages code into components`\n\n- You updated the code that caused some breaking changes\n\n`💥break: update sign-up api endpoints`\n\n- You made some changes to the user interface\n\n`🎨 style: update the auto pages`\n\n## Contributing\nAll code contributions, must go through a pull request and be approved by the maintainer before being merged. This is to ensure a proper review of all the code.\nWe truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the [contribution guide](https://github.com/Haimantika/minimalcommit/blob/main/CONTRIBUTING.md).\n\n## Support\n\nIf you like the work, please give this repo a ⭐️ and feel free to contribute to this project through issues, and pull requests.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhattakdev%2Fminimalcommit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhattakdev%2Fminimalcommit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhattakdev%2Fminimalcommit/lists"}