diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1edc1b3e6..298342bc4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,8 @@ -Public Suffix List (PSL) Pull Request (PR) Template -==== +# Public Suffix List (PSL) Submission -Each PSL PR needs to have a description, rationale, indication of DNS validation and syntax checking, as well as a number of acknowledgements from the submitter. This template must be included with each PR, and the submitting party MUST provide responses to all of the elements in order to be considered. + + ### Checklist of required steps * [ ] Description of Organization * [ ] Robust Reason for PSL Inclusion * [ ] DNS verification via dig -* [ ] Run Syntax Checker (make test) +* [ ] Run Syntax Checker (`make test`) -* [ ] Each domain listed in the PRIVATE section has and shall maintain at least two years remaining on registration, and we shall keep the \_PSL txt record in place in the respective zone(s) in the affected section +* [ ] Each domain listed in the PRIVATE section has and shall maintain at least two years remaining on registration, and we shall keep the `_psl` TXT record in place in the respective zone(s). __Submitter affirms the following:__ - * [ ] We are listing *any* third-party limits that we seek to work around in our rationale such as those between IOS 14.5+ and Facebook (see [Issue #1245](https://github.com/publicsuffix/list/issues/1245) as a well-documented example) - - [Cloudflare](https://developers.cloudflare.com/learning-paths/get-started/add-domain-to-cf/add-site/) - - [Letsencrypt](https://letsencrypt.org/docs/rate-limits/) - - + + * [ ] We are listing *any* third-party limits that we seek to work around in our rationale such as those between IOS 14.5+ and Facebook (see [Issue #1245](https://github.com/publicsuffix/list/issues/1245) as a well-documented example) + - [Cloudflare](https://developers.cloudflare.com/learning-paths/get-started/add-domain-to-cf/add-site/) + - [Let's Encrypt](https://letsencrypt.org/docs/rate-limits/) + - MAKE SURE UPDATE THE FOLLOWING LIST WITH YOUR LIMITATIONS! REMOVE ENTRIES WHICH DO NOT APPLY AS WELL AS REMOVING THIS LINE! - * [ ] This request was _not_ submitted with the objective of working around other third-party limits + * [ ] This request was _not_ submitted with the objective of working around other third-party limits. - * [ ] The submitter acknowledges that it is their responsibility to maintain the domains within their section. This includes removing names which are no longer used, retaining the _psl DNS entry, responding to e-mails to the supplied address. Failure to maintain entries may result in removal of individual entries or the entire section. + * [ ] The submitter acknowledges that it is their responsibility to maintain the domains within their section. This includes removing names which are no longer used, retaining the _psl DNS entry, and responding to e-mails to the supplied address. Failure to maintain entries may result in removal of individual entries or the entire section. - * [ ] The [Guidelines](https://github.com/publicsuffix/list/wiki/Guidelines) were carefully _read_ and _understood_, and this request conforms - * [ ] The submission follows the [guidelines](https://github.com/publicsuffix/list/wiki/Format) on formatting and sorting + * [ ] The [Guidelines](https://github.com/publicsuffix/list/wiki/Guidelines) were carefully _read_ and _understood_, and this request conforms to them. + * [ ] The submission follows the [guidelines](https://github.com/publicsuffix/list/wiki/Format) on formatting and sorting. --- -For Private section requests that are submitting entries for domains that match their organization website's primary domain, please understand that this can have impacts that may not match the desired outcome and take a long time to rollback, if at all. +For PRIVATE section requests that are submitting entries for domains that match their organization website's primary domain, please understand that this can have impacts that may not match the desired outcome and take a long time to rollback, if at all. To ensure that requested changes are entirely intentional, make sure that you read the affectation and propagation expectations, that you understand them, and confirm this understanding. @@ -108,9 +111,9 @@ guidelines. Your request could very likely alter the cookie and certificate (as well as other) behaviours on your core domain name in ways that could be problematic for your business. -Rollback is really not predictable, as those who use or incorporate +Rollbacks are really not predictable, as those who use or incorporate the PSL do what they do, and when. It is not within the PSL volunteers' -control to do anything about that. +control to do anything about that. The volunteers are busy with new requests, and rollbacks are lowest priority, so if something gets broken by your PR, it will potentially @@ -119,7 +122,7 @@ stay that way for an indefinite period of time (typically long). (Link: [about propagation/expectations](https://github.com/publicsuffix/list/wiki/Guidelines#appropriate-expectations-on-derivative-propagation-use-or-inclusion)) - * [ ] *Yes, I understand*. I could break my organization's website cookies etc. and the rollback timing, etc is acceptable. *Proceed*. + * [ ] *Yes, I understand*. I could break my organization's website cookies and cause other issues, and the rollback timing is acceptable. *Proceed anyways*. --- @@ -133,18 +136,16 @@ Example: --> -Description of Organization -==== - +## Description of Organization -Organization Website: - - -Reason for PSL Inclusion -==== +**Organization Website:** + +## Reason for PSL Inclusion -Number of users this request is being made to serve: - +**Number of users this request is being made to serve:** + -DNS Verification via dig -======= - +## DNS Verification -Results of Syntax Checker (`make test`) -========= - +## Results of Syntax Checker (`make test`) - -