Skip to content

docs: require origin/main worktrees and hub-repo dogfood - #483

Open
jimpablo wants to merge 2 commits into
Tencent:mainfrom
jimpablo:docs/479-contributing-dogfood
Open

jimpablo wants to merge 2 commits into
Tencent:mainfrom
jimpablo:docs/479-contributing-dogfood

Conversation

@jimpablo

Copy link
Copy Markdown
Contributor

Summary

Update .github/CONTRIBUTING.md so CLI contributors branch from the latest origin/main (prefer a git worktree) and dogfood the public TeamAI team repo instead of only npm install / npm link.

  • Feature branches come from origin/main, not master.
  • Required dogfood in the CLI clone: npm run build && npm link, teamai init https://github.com/teamai-hub/teamai-cli-dev --scope project --role dev, teamai pull.
  • Documented pitfalls: canonical hub URL (not a fork), do not teamai init ., Push failed (you can push manually later) is expected without write access.
  • Documented read vs write access and that git status after init/pull must not imply committing .teamai/ or AI tool dirs into teamai-cli.

No CLI behavior changes. docs/providers.md leftover master wording is left alone (out of scope for #479).

https://github.com/teamai-hub/teamai-cli-dev currently 404s; creating that repo is org-admin work, not this diff.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature causing existing behavior to change)
  • Documentation only
  • Refactor / internal cleanup

Test Plan

  • rg -n 'branch from \master`|from `master`' .github/CONTRIBUTING.md` — no matches
  • rg -n 'origin/main|worktree' .github/CONTRIBUTING.md — both present
  • CONTRIBUTING contains the exact dogfood sequence, the three pitfalls (including Push failed (you can push manually later)), the contributor/collaborator table, and the do-not-commit-local-files note
  • git diff --name-only upstream/main is only .github/CONTRIBUTING.md
  • curl -sI https://github.com/teamai-hub/teamai-cli-dev — 404 recorded; hub repo creation is out of scope

Related Issues

Closes #479

Notes for Reviewers

The hub URL and --role dev are kept verbatim from the issue even though teamai-hub/teamai-cli-dev does not exist yet.

CONTRIBUTING no longer branches from master. Contributors build, link,
and init/pull the public teamai-hub team repo from the CLI clone.

Closes Tencent#479.
Drop extra fork/upstream and worktree tutorials. Keep the original
section layout; add only the issue's dogfood sequence, pitfalls, and
access table, and switch the branch baseline to origin/main.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: fix CONTRIBUTING branch baseline and require dogfooding the public team repo

2 participants