From 10edc0a1304bb1f922399020ed8f504ca39b0499 Mon Sep 17 00:00:00 2001 From: ludamad Date: Wed, 10 Jan 2024 20:23:30 +0000 Subject: [PATCH] docs: more streamlined PR template --- .github/pull_request_template.md | 9 +-------- CONTRIBUTING.md | 7 +++++++ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 96b6f587b2fb..1801b6816261 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1 @@ -Please provide a paragraph or two giving a summary of the change, including relevant motivation and context. - -# Checklist: -Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge. -- [ ] If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag. -- [ ] I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code. -- [ ] Every change is related to the PR description. -- [ ] I have [linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) this pull request to relevant issues (if any exist). +Please read [CONTRIBUTING.md](https://github.com/AztecProtocol/aztec-packages/blob/master/CONTRIBUTING.md) for guidelines. Provide a paragraph or two giving a summary of the change, including relevant motivation and context. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d97c8ec732cd..b476783ef9c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,3 +21,10 @@ Any non-trivial code contribution must be first discussed with the maintainers i When opening the pull request you will be presented with a template and a series of instructions. Read through it carefully and follow all the steps. Expect a review and feedback from the maintainers afterward. If you're looking for a good place to start, look for issues labeled ["good first issue"](https://github.com/AztecProtocol/aztec-packages/labels/good%20first%20issue)! + +## Pull request checklist: +- I've enabled auto-merge if the PR is ready to merge. +- I have updated the yellow paper when making changes to associated functionality (e.g. outward-facing spec changes). +- I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code. +- Every change is related to the PR description.s +- I have [linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) this pull request to relevant issues (if any exist).