From 8af78ae0da951c9dfd96bd96caa49c251192b069 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Mon, 24 Feb 2020 14:23:22 -0700 Subject: [PATCH] Update pull_request_template.md First pass at an improved PR template for awesome-ipfs. @andrew -- we'll need to change the pre-submit checklist based on what you figure out surrounding the mechanisms of making a PR easier to make. In the meantime, please take a look at the remaining questions to see if they're useful for getting a bead on collabs. cc @momack2 @autonome @renrutnnej --- pull_request_template.md | 51 +++++++++++++++++++++++++++++++++------- 1 file changed, 42 insertions(+), 9 deletions(-) diff --git a/pull_request_template.md b/pull_request_template.md index 3912797..9edaf96 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -1,20 +1,53 @@ -## What kind of change is it? +## What kind of PR is this? +**Select only one** *to speed up review/approval; i.e., don't lump an addition and a removal into a single PR.* -- [ ] Addition -- [ ] Removal -- [ ] Edit -- [ ] Other +- [ ] **Adding** something new to awesome-ipfs +- [ ] **Editing** something already listed on awesome-ipfs +- [ ] **Removing** something from awesome-ipfs +- [ ] **Something else** *(if so, please explain in the "Additional details" section below)* -### Checklist +## Pre-submit checklist +**Please confirm all of the following** before submitting your PR. +- [ ] This PR includes only one addition, removal, or edit. - [ ] I edited the `/data` directory instead of the [README.md](https://github.com/ipfs/awesome-ipfs/blob/master/README.md). -- [ ] This PR includes only one addition/removal/edit. - [ ] I ran the `make build` command following my edits to the `/data` directory. - [ ] I reviewed the [content policy](https://github.com/ipfs/awesome-ipfs/blob/master/POLICY.md) to ensure my submission meets the requirements. - [ ] I have followed the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md). -## Details +## Additional details + +### What are the changes that you've made in this PR? +*Please provide details of your changes here.* + +### Is anything about IPFS blocking your project? +*If aspects of IPFS are hindering your project's progress, please elaborate here.* + +### For new additions: What is your project's *current* size/reach? +*This could be number of users, number of integrations, frequency of use, or any other key metrics. If your PR isn't for a new addition to awesome-ipfs, you can leave this out.* + +### For new additions: What is your project's *potential* size/reach? +*This could be number of users, number of integrations, frequency of use, or any other key metrics. If your PR isn't for a new addition to awesome-ipfs, you can leave this out.* + +### For new additions: How critical is IPFS to your project? +*Choose one. If your PR isn't for a new addition to awesome-ipfs, you can leave this out.* +- [ ] Essential +- [ ] Somewhat critical +- [ ] Useful, but not critical + +### For new additions: What core goal(s) does your project address? +*Choose as many as apply. If your PR isn't for a new addition to awesome-ipfs, you can leave this out.* +- [ ] Big-data solutions +- [ ] Freedom from corporate/government interference +- [ ] Data integrity +- [ ] Dev tools or other ways to enable developers +- [ ] Disaster resilience/recovery +- [ ] File storage/retrieval +- [ ] File streaming +- [ ] Permanent archiving +- [ ] Self-sovereign idenity +- [ ] Platforms that utilize consensus, reputation, or incentivization + -Provide details of your changes here.