docs: add a pull request template - #30
Merged
Merged
Conversation
This repo had none, so PR bodies arrive with no structure. Uses the same foundry-derived template as seaport and seadrop, with all guidance inside HTML comments so nothing renders except the two headings the author fills in. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Motivation
This repo has no pull request template, so PR bodies arrive with whatever structure the author picks, or none at all.
Solution
Adds
.github/pull_request_template.md, byte-identical to the one seaport and seadrop already use, plus a line pointing security reports at https://bugcrowd.com/engagements/opensea rather than a public pull request or issue.All guidance sits inside HTML comments. A contributor sees two empty headings, Motivation and Solution, and none of our prose ends up in their PR body. That failure mode is real: the mirrored packages in opensea-devtools shipped their guidance as plain markdown, and every community PR there opens with our boilerplate before the author gets a word in. See opensea-sdk pull requests 1997 through 2000.
Verified by stripping the HTML comments from the file and confirming the remainder is two headings and blank lines.