docs: propose contribution and agent guidance updates#7700
Draft
docs: propose contribution and agent guidance updates#7700
Conversation
|
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
bdbch
force-pushed
the
docs/contrib-update-proposal
branch
from
66f9979 to
7ff5eb9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes Overview
This proposal updates the contribution guide to clarify issue assignment requirements, Changeset expectations, naming conventions, licensing, and AI usage. It also adds shared agent guidance for AI coding tools via a single
AGENTS.mdsource with symlinked variants.Implementation Approach
I rewrote
CONTRIBUTING.mdaround the actual contributor flow, added explicit policy sections for Changesets, AI usage, licensing, and publishing, and introduced a rootAGENTS.mdfor repo-aware AI guidance. The existing internal Tiptap instructions were also updated so they match the current monorepo layout and trusted-publishing workflow.Testing Done
Docs-only changes. I verified the resulting markdown content, symlink targets, and git diff locally.
Verification Steps
CONTRIBUTING.mdto confirm the proposed contribution flow, AI policy, licensing guidance, and publishing language match maintainers' intent.AGENTS.mdand the symlinked entrypoints (CLAUDE.md,CODEX.md,GEMINI.md,.github/copilot-instructions.md) to confirm the guidance should be shared across tools..github/instructions/tiptap.instructions.mdto confirm the internal agent guidance matches the current repo structure and trusted publishing flow.Additional Notes
This PR is intended as a proposal for now so the wording and structure can be reviewed before finalizing.
Checklist
Related Issues
No linked issue yet. This draft PR is opened as a proposal for discussion.