Skip to content

Create a checklist in the PR template to encourage careful reading of the readme #859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wgreenberg merged 5 commits into from
Mar 17, 2026
Merged

Create a checklist in the PR template to encourage careful reading of the readme #859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8d87028
create pull request template
ohemorange Mar 6, 2026
0d81f93
expand guidance in readme
ohemorange Mar 6, 2026
24f84cd
add readme link
ohemorange Mar 6, 2026
e4e6670
typo: extra quote
ohemorange Mar 17, 2026
4fda5e4
say an empty string explicitly
ohemorange Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Copy Markdown
Contributor Author

@ohemorange ohemorange Mar 6, 2026

Choose a reason for hiding this comment

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

While we could add an "if you're updating the hosting providers file" clause, I don't think that's super worth it as that's really the only contributions we get to this repo.

14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: `""`
Loading