{"id":45750586,"url":"https://github.com/warengonzaga/contribute-now","last_synced_at":"2026-03-02T16:00:37.972Z","repository":{"id":340583794,"uuid":"1165582856","full_name":"warengonzaga/contribute-now","owner":"warengonzaga","description":"Squash, Merge, Stay in Sync","archived":false,"fork":false,"pushed_at":"2026-02-28T13:03:51.000Z","size":263,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-28T16:38:12.378Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://waren.build/contribute-now/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/warengonzaga.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-02-24T10:17:52.000Z","updated_at":"2026-02-28T13:03:05.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/warengonzaga/contribute-now","commit_stats":null,"previous_names":["warengonzaga/contribute-now"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/warengonzaga/contribute-now","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/warengonzaga%2Fcontribute-now","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/warengonzaga%2Fcontribute-now/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/warengonzaga%2Fcontribute-now/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/warengonzaga%2Fcontribute-now/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/warengonzaga","download_url":"https://codeload.github.com/warengonzaga/contribute-now/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/warengonzaga%2Fcontribute-now/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29973074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T14:44:57.896Z","status":"ssl_error","status_checked_at":"2026-03-01T14:43:27.662Z","response_time":124,"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":[],"created_at":"2026-02-25T18:15:11.279Z","updated_at":"2026-03-01T15:00:44.858Z","avatar_url":"https://github.com/warengonzaga.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# contribute-now\n\n![GitHub Repo Banner](https://ghrb.waren.build/banner?header=contribute-now+%F0%9F%94%84\u0026subheader=Any+workflow.+Clean+commits.+Zero+friction.\u0026bg=0D1117-21262D\u0026color=FFFFFF\u0026headerfont=Google+Sans+Code\u0026subheaderfont=Sour+Gummy\u0026support=true)\n\u003c!-- Created with GitHub Repo Banner by Waren Gonzaga: https://ghrb.waren.build --\u003e\n\n**contribute-now** is a developer CLI that automates git workflows — branching, syncing, staging, committing, and opening PRs — so you can focus on shipping, not on memorizing git commands.\n\nIt natively supports multiple workflow models and commit conventions, with AI-powered assistance throughout.\n\n[![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![npm version](https://img.shields.io/npm/v/contribute-now.svg)](https://www.npmjs.com/package/contribute-now)\n\n---\n\n## Workflow Modes\n\nPick the model that matches your project during `contrib setup`. contribute-now adapts its commands to your chosen workflow automatically — no manual branch names to remember.\n\n| Mode | Branches | Strategy | Default |\n|------|----------|----------|:-------:|\n| 🌊 **Clean Flow** *(by WGTech Labs)* | `main` + `dev` + feature branches | Squash features → `dev`, merge `dev` → `main` | ✅ |\n| 🐙 **GitHub Flow** | `main` + feature branches | Squash/merge features → `main` | |\n| 🔀 **Git Flow** | `main` + `develop` + release/hotfix branches | Full ceremony branching | |\n\n## Commit Conventions\n\ncontribute-now validates commit messages and guides your AI toward the right format — based on whichever convention you configure.\n\n| Convention | Format | Default |\n|------------|--------|:-------:|\n| 🧹 **Clean Commit** *(by WGTech Labs)* | `\u003cemoji\u003e \u003ctype\u003e[!][(\u003cscope\u003e)]: \u003cdescription\u003e` | ✅ |\n| 📝 **Conventional Commits** | `\u003ctype\u003e[!][(\u003cscope\u003e)]: \u003cdescription\u003e` | |\n| 🚫 **None** | No enforcement | |\n\n---\n\n## Quick Start\n\n```bash\nnpx contribute-now setup\n```\n\nOr install globally:\n\n```bash\nnpm install -g contribute-now\ncontrib setup\n```\n\n\u003e Both `contrib` and `contribute` invoke the same binary.\n\n---\n\n## Installation\n\n```bash\n# npm\nnpm install -g contribute-now\n\n# bun\nbun install -g contribute-now\n```\n\n## Prerequisites\n\n- **[Git](https://git-scm.com/)** — required\n- **[GitHub CLI](https://cli.github.com)** (`gh`) — optional; enables role auto-detection and PR creation\n- **[GitHub Copilot](https://github.com/features/copilot)** — optional; enables AI features\n\n---\n\n## Commands\n\n### `contrib setup`\n\nInteractive setup wizard. Configures your repo's workflow mode, commit convention, your role, and branch/remote names. Writes `.contributerc.json`.\n\n```bash\ncontrib setup\n```\n\nSteps:\n1. Choose **workflow mode** — Clean Flow, GitHub Flow, or Git Flow\n2. Choose **commit convention** — Clean Commit, Conventional Commits, or None\n3. Detect remotes and auto-detect your **role** (maintainer or contributor)\n4. Confirm branch and remote names\n5. Write `.contributerc.json`\n\n---\n\n### `contrib sync`\n\nPull the latest changes from the correct remote branch based on your workflow and role.\n\n```bash\ncontrib sync         # with confirmation\ncontrib sync --yes   # skip confirmation\n```\n\n| Role | Clean Flow / Git Flow | GitHub Flow |\n|------|-----------------------|-------------|\n| Maintainer | pulls `origin/dev` | pulls `origin/main` |\n| Contributor | pulls `upstream/dev` | pulls `upstream/main` |\n\n---\n\n### `contrib start`\n\nCreate a new feature branch from the correct base branch, with optional AI-powered branch naming.\n\n```bash\n# Direct branch name\ncontrib start feature/user-auth\n\n# Natural language — AI suggests the branch name\ncontrib start \"add user authentication\"\n\n# Skip AI\ncontrib start \"add user authentication\" --no-ai\n```\n\n---\n\n### `contrib commit`\n\nStage your changes and create a validated, AI-generated commit message matching your configured convention.\n\n```bash\ncontrib commit                     # AI-generated message\ncontrib commit --no-ai             # manual entry, still validated\ncontrib commit --model gpt-4.1    # specific AI model\n```\n\nAfter the AI generates a message, you can **accept**, **edit**, **regenerate**, or **write manually**. Messages are always validated against your convention — with a soft warning if they don't match (you can still commit).\n\n---\n\n### `contrib update`\n\nRebase your current branch onto the latest base branch, with AI guidance if conflicts occur.\n\n```bash\ncontrib update\ncontrib update --no-ai   # skip AI conflict guidance\n```\n\n---\n\n### `contrib submit`\n\nPush your branch and open a pull request with an AI-generated title and description.\n\n```bash\ncontrib submit\ncontrib submit --draft\ncontrib submit --no-ai\ncontrib submit --model gpt-4.1\n```\n\n---\n\n### `contrib clean`\n\nDelete merged branches and prune stale remote refs.\n\n```bash\ncontrib clean          # shows candidates, asks to confirm\ncontrib clean --yes    # skip confirmation\n```\n\n---\n\n### `contrib status`\n\nShow a sync status dashboard for your main, dev, and current branch.\n\n```bash\ncontrib status\n```\n\n---\n\n### `contrib hook`\n\nInstall or uninstall a `commit-msg` git hook that validates every commit against your configured convention — no Husky or lint-staged needed.\n\n```bash\ncontrib hook install     # writes .git/hooks/commit-msg\ncontrib hook uninstall   # removes it\n```\n\n- Automatically skips merge commits, fixup, squash, and amend commits\n- Won't overwrite hooks it didn't create\n\n---\n\n### `contrib validate`\n\nValidate a commit message against your configured convention. Exits `0` if valid, `1` if not — useful in CI pipelines or custom hooks.\n\n```bash\ncontrib validate \"📦 new: user auth module\"     # exit 0\ncontrib validate \"added stuff\"                   # exit 1\n```\n\n---\n\n## AI Features\n\nAll AI features are powered by **GitHub Copilot** via `@github/copilot-sdk` and are entirely **optional** — every command has a manual fallback.\n\n| Command | AI Feature | Fallback |\n|---------|------------|---------|\n| `commit` | Generate commit message from staged diff | Type manually |\n| `start` | Suggest branch name from natural language | Prefix picker + manual |\n| `update` | Conflict resolution guidance | Standard git instructions |\n| `submit` | Generate PR title and body | `gh pr create --fill` or manual |\n\nPass `--no-ai` to any command to skip AI entirely. Use `--model \u003cname\u003e` to select a specific Copilot model (e.g., `gpt-4.1`, `claude-sonnet-4`).\n\n---\n\n## Commit Convention Reference\n\n### Clean Commit *(default)*\n\nFormat: `\u003cemoji\u003e \u003ctype\u003e[!][(\u003cscope\u003e)]: \u003cdescription\u003e`\n\n| Emoji | Type | When to use |\n|:-----:|------|-------------|\n| 📦 | `new` | New features, files, or capabilities |\n| 🔧 | `update` | Changes, refactoring, improvements |\n| 🗑️ | `remove` | Removing code, files, or dependencies |\n| 🔒 | `security` | Security fixes or patches |\n| ⚙️ | `setup` | Configs, CI/CD, tooling, build systems |\n| ☕ | `chore` | Maintenance, dependency updates |\n| 🧪 | `test` | Adding or updating tests |\n| 📖 | `docs` | Documentation changes |\n| 🚀 | `release` | Version releases |\n\nExamples:\n```\n📦 new: user authentication system\n🔧 update (api): improve error handling\n⚙️ setup (ci): configure github actions\n🔧 update!: breaking change to config format\n```\n\n→ [Clean Commit spec](https://github.com/wgtechlabs/clean-commit)\n\n### Conventional Commits\n\nFormat: `\u003ctype\u003e[!][(\u003cscope\u003e)]: \u003cdescription\u003e`\n\nTypes: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`\n\nExamples:\n```\nfeat: add user authentication\nfix(auth): resolve token expiry issue\ndocs: update contributing guide\nfeat!: redesign authentication API\n```\n\n→ [conventionalcommits.org](https://www.conventionalcommits.org/)\n\n---\n\n## Config File\n\n`contrib setup` writes `.contributerc.json` to your repo root:\n\n```json\n{\n  \"workflow\": \"clean-flow\",\n  \"commitConvention\": \"clean-commit\",\n  \"role\": \"contributor\",\n  \"mainBranch\": \"main\",\n  \"devBranch\": \"dev\",\n  \"upstream\": \"upstream\",\n  \"origin\": \"origin\",\n  \"branchPrefixes\": [\"feature\", \"fix\", \"docs\", \"chore\", \"test\", \"refactor\"]\n}\n```\n\n\u003e Add `.contributerc.json` to your `.gitignore` — it contains personal config and should not be committed.\n\n---\n\n## Development\n\n```bash\ngit clone https://github.com/warengonzaga/contribute-now.git\ncd contribute-now\nbun install\n\nbun run build   # compile to dist/index.js\nbun test        # run tests\nbun run lint    # check code quality\n```\n\n## Contributing\n\nContributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for the workflow, commit convention, and PR guidelines.\n\n## License\n\n[GPL-3.0](LICENSE) © [Waren Gonzaga](https://warengonzaga.com)\n\n---\n\n💻💖☕ Made with ❤️ by [Waren Gonzaga](https://github.com/warengonzaga)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwarengonzaga%2Fcontribute-now","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwarengonzaga%2Fcontribute-now","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwarengonzaga%2Fcontribute-now/lists"}