-
Notifications
You must be signed in to change notification settings - Fork 15
Update PR docs #1540
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update PR docs #1540
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR consolidates and improves documentation for the ENSNode pull request process by moving detailed guidance from PR templates into dedicated documentation pages on the ENSNode docs site.
Changes:
- Created a new dedicated PR documentation page (
prs.mdx) covering PR templates, standard PR process, changesets, and PR description checks - Reorganized the releases documentation by removing changeset instructions and renaming from "Contributing to Releases" to "Creating a Release"
- Simplified the Lite PR template by removing the tips section and adding a link to the new comprehensive PR documentation
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
docs/ensnode.io/src/content/docs/docs/contributing/prs.mdx |
New documentation page covering pull request processes, templates, and changeset guidelines |
docs/ensnode.io/src/content/docs/docs/contributing/releases.mdx |
Removed changeset instructions (moved to prs.mdx), updated title and sidebar order |
.github/pull_request_template.md |
Added link to PR documentation, removed inline tips section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Greptile SummaryConsolidated PR process documentation by moving content from the Lite PR template into dedicated documentation pages. The PR template now links to comprehensive docs covering PR workflows, changesets, and release processes. Key changes:
Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant Template as PR Template
participant Docs as Documentation Site
participant Bot as Changesets Bot
Dev->>Template: Opens PR using Lite template
Template->>Docs: Links to comprehensive PR docs
Dev->>Docs: Reviews PR process guidelines
Docs->>Dev: Shows changeset criteria & instructions
Dev->>Dev: Runs `pnpm changeset`
Dev->>Template: Completes PR checklist
Template->>Bot: Validates checkboxes
Bot->>Dev: Comments with changeset confirmation
Dev->>Docs: References release selection guide
Docs->>Dev: Explains Full/Snapshot/Preview releases
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
3 files reviewed, 1 comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@greptile |
lightwalker-eth
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Self review completed
tk-o
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
Why
Testing
Pre-Review Checklist (Blocking)