diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..8c02bba02 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,3 @@ +## Pull Request Checklist + +- [ ] 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. diff --git a/README.md b/README.md index 3c693f970..f988df612 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,13 @@ If you notice information that’s out of date or incorrect, [submit a pull requ - Make sure to fill out the `name`, `link`, `category`, and `reviewed` fields. - `reviewed` should be a date in format `2019.7.11`. - `link` is usually a link to the provider's main page; it's where clicking on the name will go. -- for `category`, see descriptions [here](https://certbot.eff.org/hosting_providers/). -- for `full`/`partial` categories, one of the links provided should have evidence of being in that category. - - only one of `tutorial`, `announcement`, `plan` will show up, in that order. +- For `category`, see descriptions [here](https://certbot.eff.org/hosting_providers/). + - If a user must take any action at all after creating their website, it is not `full` support. + - If the provider offers both `partial` and `full` support, this is `partial` support, along with a note explaining where full support is available. +- For `full`/`partial` categories, one of the links provided should have evidence of being in that category. + - Only one of `tutorial`, `announcement`, `plan` will show up, in that order. Please do not include more than one of these links. - `partial` should have `tutorial`. - `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. -- if one provider offers multiple products, either split into two entries or note it in the `note` field. -- 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. -- all unused fields should be `""` +- If one provider offers multiple products, either split into two entries or note it in the `note` field. +- 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." +- All unused fields should be an empty string: `""`