Idris2/.github/pull_request_template.md

# Description


## Should this change go in the CHANGELOG?

<!-- Please delete this section if it doesn't apply -->
- [ ] If this is a fix, user-facing change, a compiler change, or a new paper
      implementation, I have updated [`CHANGELOG_NEXT.md`](https://github.com/idris-lang/Idris2/blob/main/CHANGELOG_NEXT.md) (and potentially also
      `CONTRIBUTORS.md`).
[ admin ] Update what should go in the changelog (#2905) * [ admin ] Update what should go in the changelog There has been some stuff inconsistently slipping through the cracks, so it is probably best to explicitly include it. * [ admin ] Bloody linter... * [ admin ] Third time's the charm? Dear linter: [REDACTED] * [ admin ] Reword PR template "an addition" is too broad for what it was intended for: paper implementations 2023-03-03 18:46:06 +03:00			`# Description`


			`## Should this change go in the CHANGELOG?`
[ admin ] Update CHANGELOG and CONTRIBUTORS (#2703) * [ admin ] Update CHANGELOG and CONTRIBUTORS We really need to do a release at some point... * [ ci ] Don't check capitalised proper names in links and code Sometimes hyperlinks and code-blocks just don't use the "proper" capitalisation (e.g. `.html` vs `.HTML`), and that's okay. (or even critical as links may not be found without "incorrect" format) * [ ci ] Don't check terminology in links and code-blocks Hopefully this is the right fix for the problem in #2703 * [ ci ] 3rd attempt at fixing nl linter * [ ci ] Attempt no. 4 at fixing nl linter * [ ci ] Point NL linter at YAML config file Was that actually it?? * Update CHANGELOG.md * Add note about forward declaration of records * [ admin ] Add PR template with CHANGELOG reminder To hopefully help mitigate big crawl-throughs of what's changed, à la #2703. * [ admin ] Reflow CHANGELOG to 80 characters where possible Only done for the "next version" changes for the sake of diff size. (Personally, I'd want to have the linter enforce this, but that might be too extreme; there's already a note in the CI config complaining about line length...) * [ admin ] Make linter happy It never ends... Co-authored-by: Joel Berkeley <16429957+joelberkeley@users.noreply.github.com> Co-authored-by: Steve Dunham <dunhamsteve@gmail.com> 2022-10-21 17:48:37 +03:00
			`<!-- Please delete this section if it doesn't apply -->`
[ admin ] Update what should go in the changelog (#2905) * [ admin ] Update what should go in the changelog There has been some stuff inconsistently slipping through the cracks, so it is probably best to explicitly include it. * [ admin ] Bloody linter... * [ admin ] Third time's the charm? Dear linter: [REDACTED] * [ admin ] Reword PR template "an addition" is too broad for what it was intended for: paper implementations 2023-03-03 18:46:06 +03:00			`- [ ] If this is a fix, user-facing change, a compiler change, or a new paper`
Add a new CHANGELOG_NEXT.md file and update documentation around CHANGELOG entries. (#3180) 2024-01-02 06:08:56 +03:00			implementation, I have updated [`CHANGELOG_NEXT.md`](https://github.com/idris-lang/Idris2/blob/main/CHANGELOG_NEXT.md) (and potentially also
[ admin ] Update what should go in the changelog (#2905) * [ admin ] Update what should go in the changelog There has been some stuff inconsistently slipping through the cracks, so it is probably best to explicitly include it. * [ admin ] Bloody linter... * [ admin ] Third time's the charm? Dear linter: [REDACTED] * [ admin ] Reword PR template "an addition" is too broad for what it was intended for: paper implementations 2023-03-03 18:46:06 +03:00			`CONTRIBUTORS.md`).
[ admin ] Update CHANGELOG and CONTRIBUTORS (#2703) * [ admin ] Update CHANGELOG and CONTRIBUTORS We really need to do a release at some point... * [ ci ] Don't check capitalised proper names in links and code Sometimes hyperlinks and code-blocks just don't use the "proper" capitalisation (e.g. `.html` vs `.HTML`), and that's okay. (or even critical as links may not be found without "incorrect" format) * [ ci ] Don't check terminology in links and code-blocks Hopefully this is the right fix for the problem in #2703 * [ ci ] 3rd attempt at fixing nl linter * [ ci ] Attempt no. 4 at fixing nl linter * [ ci ] Point NL linter at YAML config file Was that actually it?? * Update CHANGELOG.md * Add note about forward declaration of records * [ admin ] Add PR template with CHANGELOG reminder To hopefully help mitigate big crawl-throughs of what's changed, à la #2703. * [ admin ] Reflow CHANGELOG to 80 characters where possible Only done for the "next version" changes for the sake of diff size. (Personally, I'd want to have the linter enforce this, but that might be too extreme; there's already a note in the CI config complaining about line length...) * [ admin ] Make linter happy It never ends... Co-authored-by: Joel Berkeley <16429957+joelberkeley@users.noreply.github.com> Co-authored-by: Steve Dunham <dunhamsteve@gmail.com> 2022-10-21 17:48:37 +03:00