docs: improve repository contribution guidance - #2671
Merged
Conversation
Deploying greptime-docs with
|
| Latest commit: |
7a79864
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7c0970b6.greptime-docs.pages.dev |
| Branch Preview URL: | https://codex-add-agent-guidelines.greptime-docs.pages.dev |
killme2008
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates repository-wide contributor workflow documentation and GitHub templates/forms to make reporting and contribution expectations clearer and more standardized.
Changes:
- Rewrites
CONTRIBUTING.mdinto a shorter, more actionable guide covering setup, versioning, links/anchors, generated files, and pre-PR checks. - Adds a concise
AGENTS.mdguide for coding agents/contributors, aligned with the repo workflow. - Simplifies the PR template and adds issue forms for documentation problems/requests (plus issue template configuration).
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| CONTRIBUTING.md | Replaces the long-form guide with a concise, structured contributor workflow and repo conventions. |
| AGENTS.md | Adds an agent-focused operational guide that points back to CONTRIBUTING for source-of-truth details. |
| .gitignore | Ignores .local/ agent override files while keeping the shared guide tracked. |
| .github/pull_request_template.md | Simplifies the template into “What changed / Scope / Verification / Checklist”. |
| .github/ISSUE_TEMPLATE/documentation-request.yml | Adds an issue form for requesting new/expanded documentation. |
| .github/ISSUE_TEMPLATE/documentation-problem.yml | Adds an issue form for reporting incorrect/outdated/broken documentation. |
| .github/ISSUE_TEMPLATE/config.yml | Disables blank issues and adds contact links directing users to the right support channels. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sunng87
reviewed
Jul 30, 2026
sunng87
approved these changes
Jul 30, 2026
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
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.
What changed
AGENTS.mdfor coding agents and a portableCLAUDE.mdimport.local/for machine-local agent instructionsCONTRIBUTING.mdwith current setup, version, localization, link, anchor, generated-file, backport, sidebar, shared-content, variable, and release-note guidanceThis PR depends on #2669 for the documented
AnchorAliascomponent,pnpm check:linkscommand, and package lifecycle behavior. Merge it after #2669.Scope
Verification
npx --yes markdownlint-cli@0.45.0 --config .markdownlint.yaml AGENTS.md CLAUDE.md CONTRIBUTING.md .github/pull_request_template.mdtypos AGENTS.md CLAUDE.md CONTRIBUTING.md .github/pull_request_template.md .github/ISSUE_TEMPLATE/*.ymlgit diff --checkCLAUDE.mdis a regular file importingAGENTS.mdChecklist