Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

chore: add pr template #3970

Closed
wants to merge 2 commits into from
Closed

chore: add pr template #3970

wants to merge 2 commits into from

Conversation

MicaiahReid
Copy link
Contributor

@MicaiahReid MicaiahReid commented Nov 30, 2022

PR description

This PR introduces a PR template that will be used to guide contributors on a format for creating PRs in the Ganache repo. Fixes #3758

We can bike shed this to our heart's content, but I figured I'd get something out to start the conversation. By the way, this PR description uses the template.

Testing instructions

N/A

Documentation

  • I've added the doc-change-required label to this PR so that documentation can be added by the docs team in another PR.
  • I've included documentation changes in this PR:
    • I've updated the README.md.
    • I've updated the CONTRIBUTING.md.
    • I've added/updated an RPC method in src/chains/ethereum/ethereum/RPC-METHODS.md.
    • I've added/updated a JS-DOC example of a new RPC method in src/chains/ethereum/ethereum/src/api.ts.
  • This PR does not require documentation changes.
  • I don't know what this PR needs in regards to documentation.

Release Notes

This change introduces a PR template that will be used to guide contributors on a format for creating PRs in the Ganache repo.

Copy link
Contributor

@jeffsmale90 jeffsmale90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love it!

Copy link
Contributor

@tenthirtyone tenthirtyone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

I usually see two different types of PR template. This kind and a 'preflgiht pr checklist' is how I think of the 2nd.

https://github.com/devspace/awesome-github-templates

I like these a lot for starting a funnel before we triage issues, too, if it works out for PRs.

@MicaiahReid
Copy link
Contributor Author

I've rearranged a bit and added some further comments to make very clear that most of the information is optional for external contributors. @davidmurdoch's concern is that these templates will be a barrier to entry or an annoyance for some contributors, and we definitely don't want that. Input welcome.

@davidmurdoch
Copy link
Member

I don't like it :-/

@MicaiahReid
Copy link
Contributor Author

Seems like this isn't something we think is best for us right now.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

make PR template
4 participants