Skip to content

Commit dd52d10

Browse files
authored
Merge pull request #859 from certbot/pr-checklist
Create a checklist in the PR template to encourage careful reading of the readme
2 parents 4ec016a + 4fda5e4 commit dd52d10

2 files changed

Lines changed: 11 additions & 6 deletions

File tree

.github/pull_request_template.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Pull Request Checklist
2+
3+
- [ ] I have carefully read and fully understood the instructions in [the README file](https://github.com/certbot/website/blob/master/README.md), and I attest that this pull request conforms to those instructions.

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ If you notice information that’s out of date or incorrect, [submit a pull requ
1313
- Make sure to fill out the `name`, `link`, `category`, and `reviewed` fields.
1414
- `reviewed` should be a date in format `2019.7.11`.
1515
- `link` is usually a link to the provider's main page; it's where clicking on the name will go.
16-
- for `category`, see descriptions [here](https://certbot.eff.org/hosting_providers/).
17-
- for `full`/`partial` categories, one of the links provided should have evidence of being in that category.
18-
- only one of `tutorial`, `announcement`, `plan` will show up, in that order.
16+
- For `category`, see descriptions [here](https://certbot.eff.org/hosting_providers/).
17+
- If a user must take any action at all after creating their website, it is not `full` support.
18+
- If the provider offers both `partial` and `full` support, this is `partial` support, along with a note explaining where full support is available.
19+
- For `full`/`partial` categories, one of the links provided should have evidence of being in that category.
20+
- Only one of `tutorial`, `announcement`, `plan` will show up, in that order. Please do not include more than one of these links.
1921
- `partial` should have `tutorial`.
2022
- `full` providers shouldn't need a tutorial to turn on https. an exception might include instructions of what to do if something goes wrong and the automatic https doesn't work.
21-
- if one provider offers multiple products, either split into two entries or note it in the `note` field.
22-
- the `note` field is good for things like noting which products have https, or that the site is available only in certain languages. it's not meant to advertise the hosting provider's site/offerings.
23-
- all unused fields should be `""`
23+
- If one provider offers multiple products, either split into two entries or note it in the `note` field.
24+
- The `note` field is good for things like noting which products have https, or that the site is available only in certain languages. it's not meant to advertise the hosting provider's site/offerings, or for a generic description like "offers free certificates."
25+
- All unused fields should be an empty string: `""`

0 commit comments

Comments
 (0)