chore: sync templates/*.md files with issue templates #16758

gfyoung · 2023-01-07T08:06:59Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

The issue templates are essentially more advanced versions of the ones that were being (redundantly) maintained in the templates directory. Used relative paths instead instead of hardcoding eslint/eslint/HEAD because that makes it easier to review a branch that makes any direct changes to the referenced documentation files within a file like this one.

Is there anything you'd like reviewers to focus on?

N/A

netlify · 2023-01-07T08:07:06Z

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	`2339a7a`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/63bc618eca1581000808372b

.github/PULL_REQUEST_TEMPLATE.md

gfyoung · 2023-01-07T17:05:51Z

https://github.com/eslint/eslint/actions/runs/3863046536/jobs/6584991911#step:5:50

This failure looks flaky for reasons unrelated to this PR. Seeing same failure in another PR:

https://github.com/eslint/eslint/actions/runs/3843668330/jobs/6546117108#step:5:50

This happened in my other PR too, but I can't restart the build to make it ✅.

snitin315 · 2023-01-08T09:45:29Z

Removed accepted and added evaluating since we don't have a consensus on this.

mdjermanovic · 2023-01-08T10:29:03Z

I think the best path forward is to update the markdown templates if there is a difference in content. We do allow PRs without issues, and copy-pasting plain text from rendered GitHub issue templates doesn't seem like a good alternative to markdown.

gfyoung · 2023-01-08T10:33:43Z

We do allow PRs without issues

@mdjermanovic: My maintainer preference is to discuss issues separately from a PR where possible. For eslint, his would especially be applicable in cases of new rules and rule changes. That said, if that is a not concern for you guys, and you don't mind maintaining duplicate issue templates, I can modify this PR to just sync the Markdown content to the YML one.

mdjermanovic · 2023-01-08T12:18:32Z

@gfyoung those are good points, and we may or may not revisit our PR policies in the future. However, the discussion about the policies doesn't seem relevant to this change, because this change does not enforce different policies. If and when we decide to require an issue, we'd probably need different changes to the PR template (for example, a checkbox to confirm that the PR addresses an issue, or a mandatory issue id field). This change as it is now, in my opinion, makes it more difficult for contributors to submit a PR under the current policies. Maintaining duplicate templates isn't ideal, but there doesn't seem to be a better alternative.

gfyoung · 2023-01-08T20:13:28Z

Maintaining duplicate templates isn't ideal, but there doesn't seem to be a better alternative.

Fair. I've updated the PR to just sync the content between the two then.

mdjermanovic

LGTM, thanks! Leaving open for others to review.

templates/rule-change-proposal.md

Co-authored-by: Strek <ssharishkumar@gmail.com>

snitin315

LGTM, thanks for contributing.

harish-sethuraman

Thanks

kecrily

LGTM

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.31.0` -> `8.32.0`](https://renovatebot.com/diffs/npm/eslint/8.31.0/8.32.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.32.0`](https://github.com/eslint/eslint/releases/tag/v8.32.0) [Compare Source](eslint/eslint@v8.31.0...v8.32.0) #### Features - [`fc20f24`](eslint/eslint@fc20f24) feat: add suggestions for redundant wrapping in prefer-regex-literals ([#16658](eslint/eslint#16658)) (YeonJuan) #### Bug Fixes - [`b4f8329`](eslint/eslint@b4f8329) fix: ignore directives for no-fallthrough ([#16757](eslint/eslint#16757)) (gfyoung) #### Documentation - [`17b65ad`](eslint/eslint@17b65ad) docs: IA Update page URL move ([#16665](eslint/eslint#16665)) (Ben Perlmutter) - [`5981296`](eslint/eslint@5981296) docs: fix theme switcher button ([#16752](eslint/eslint#16752)) (Sam Chen) - [`6669413`](eslint/eslint@6669413) docs: deploy prerelease docs under the `/docs/next/` path ([#16541](eslint/eslint#16541)) (Nitin Kumar) - [`78ecfe0`](eslint/eslint@78ecfe0) docs: use inline code for rule options name ([#16768](eslint/eslint#16768)) (Percy Ma) - [`fc2ea59`](eslint/eslint@fc2ea59) docs: Update README (GitHub Actions Bot) - [`762a872`](eslint/eslint@762a872) docs: Update README (GitHub Actions Bot) #### Chores - [`2952d6e`](eslint/eslint@2952d6e) chore: sync templates/\*.md files with issue templates ([#16758](eslint/eslint#16758)) (gfyoung) - [`3e34418`](eslint/eslint@3e34418) chore: Add new issues to triage project ([#16740](eslint/eslint#16740)) (Nicholas C. Zakas) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1734 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

gfyoung requested a review from a team as a code owner January 7, 2023 08:07

eslint-github-bot bot added triage An ESLint team member will look at this issue soon documentation Relates to ESLint's documentation labels Jan 7, 2023

amareshsm added accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jan 7, 2023

amareshsm changed the title ~~docs: simplify PR template documentation~~ chore: simplify PR template documentation Jan 7, 2023

kecrily requested changes Jan 7, 2023

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

mdjermanovic reviewed Jan 7, 2023

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

eslint-github-bot bot added the chore This change is not user-facing label Jan 7, 2023

snitin315 added evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed accepted There is consensus among the team that this change meets the criteria for inclusion labels Jan 8, 2023

chore: sync templates/*.md files with issue templates

3b76d8a

gfyoung force-pushed the pr-templates-simplify branch from a8b724e to 3b76d8a Compare January 8, 2023 20:12

gfyoung changed the title ~~chore: simplify PR template documentation~~ chore: sync templates/*.md files with issue templates Jan 8, 2023

mdjermanovic approved these changes Jan 9, 2023

View reviewed changes

harish-sethuraman added accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Jan 9, 2023

harish-sethuraman reviewed Jan 9, 2023

View reviewed changes

templates/rule-change-proposal.md Outdated Show resolved Hide resolved

harish-sethuraman reviewed Jan 9, 2023

View reviewed changes

templates/rule-change-proposal.md Outdated Show resolved Hide resolved

Remove duplicate question marks

2339a7a

Co-authored-by: Strek <ssharishkumar@gmail.com>

snitin315 approved these changes Jan 10, 2023

View reviewed changes

snitin315 requested review from kecrily and harish-sethuraman January 10, 2023 02:39

harish-sethuraman approved these changes Jan 10, 2023

View reviewed changes

kecrily approved these changes Jan 10, 2023

View reviewed changes

snitin315 merged commit 2952d6e into eslint:main Jan 10, 2023
21 checks passed

gfyoung deleted the pr-templates-simplify branch January 10, 2023 10:06

chore: sync templates/*.md files with issue templates #16758

chore: sync templates/*.md files with issue templates #16758

gfyoung commented Jan 7, 2023 •

edited

netlify bot commented Jan 7, 2023 •

edited

gfyoung commented Jan 7, 2023

snitin315 commented Jan 8, 2023

mdjermanovic commented Jan 8, 2023

gfyoung commented Jan 8, 2023 •

edited

mdjermanovic commented Jan 8, 2023

gfyoung commented Jan 8, 2023 •

edited

mdjermanovic left a comment

snitin315 left a comment

harish-sethuraman left a comment

kecrily left a comment

chore: sync templates/*.md files with issue templates #16758

chore: sync templates/*.md files with issue templates #16758

Conversation

gfyoung commented Jan 7, 2023 • edited

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

netlify bot commented Jan 7, 2023 • edited

✅ Deploy Preview for docs-eslint canceled.

gfyoung commented Jan 7, 2023

snitin315 commented Jan 8, 2023

mdjermanovic commented Jan 8, 2023

gfyoung commented Jan 8, 2023 • edited

mdjermanovic commented Jan 8, 2023

gfyoung commented Jan 8, 2023 • edited

mdjermanovic left a comment

Choose a reason for hiding this comment

snitin315 left a comment

Choose a reason for hiding this comment

harish-sethuraman left a comment

Choose a reason for hiding this comment

kecrily left a comment

Choose a reason for hiding this comment

gfyoung commented Jan 7, 2023 •

edited

netlify bot commented Jan 7, 2023 •

edited

gfyoung commented Jan 8, 2023 •

edited

gfyoung commented Jan 8, 2023 •

edited