Skip to content
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.

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

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

Merged
merged 2 commits into from Jan 10, 2023

Conversation

gfyoung
Copy link
Contributor

@gfyoung gfyoung commented Jan 7, 2023

Prerequisites checklist

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

@gfyoung gfyoung requested a review from a team as a code owner January 7, 2023 08:07
@eslint-github-bot 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
@netlify
Copy link

netlify bot commented Jan 7, 2023

Deploy Preview for docs-eslint canceled.

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

@amareshsm 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 amareshsm changed the title docs: simplify PR template documentation chore: simplify PR template documentation Jan 7, 2023
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
@eslint-github-bot eslint-github-bot bot added the chore This change is not user-facing label Jan 7, 2023
@gfyoung
Copy link
Contributor Author

gfyoung commented Jan 7, 2023

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 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
@snitin315
Copy link
Contributor

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

@mdjermanovic
Copy link
Member

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
Copy link
Contributor Author

gfyoung commented Jan 8, 2023

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
Copy link
Member

@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 gfyoung changed the title chore: simplify PR template documentation chore: sync templates/*.md files with issue templates Jan 8, 2023
@gfyoung
Copy link
Contributor Author

gfyoung commented Jan 8, 2023

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.

Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! Leaving open for others to review.

@harish-sethuraman 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
Co-authored-by: Strek <ssharishkumar@gmail.com>
Copy link
Contributor

@snitin315 snitin315 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for contributing.

Copy link
Member

@harish-sethuraman harish-sethuraman left a comment

Choose a reason for hiding this comment

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

Thanks

Copy link
Member

@kecrily kecrily left a comment

Choose a reason for hiding this comment

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

LGTM

@snitin315 snitin315 merged commit 2952d6e into eslint:main Jan 10, 2023
21 checks passed
@gfyoung gfyoung deleted the pr-templates-simplify branch January 10, 2023 10:06
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Jan 17, 2023
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 ([#&#8203;16658](eslint/eslint#16658)) (YeonJuan)

#### Bug Fixes

-   [`b4f8329`](eslint/eslint@b4f8329) fix: ignore directives for no-fallthrough ([#&#8203;16757](eslint/eslint#16757)) (gfyoung)

#### Documentation

-   [`17b65ad`](eslint/eslint@17b65ad) docs: IA Update page URL move ([#&#8203;16665](eslint/eslint#16665)) (Ben Perlmutter)
-   [`5981296`](eslint/eslint@5981296) docs: fix theme switcher button ([#&#8203;16752](eslint/eslint#16752)) (Sam Chen)
-   [`6669413`](eslint/eslint@6669413) docs: deploy prerelease docs under the `/docs/next/` path ([#&#8203;16541](eslint/eslint#16541)) (Nitin Kumar)
-   [`78ecfe0`](eslint/eslint@78ecfe0) docs: use inline code for rule options name ([#&#8203;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 ([#&#8203;16758](eslint/eslint#16758)) (gfyoung)
-   [`3e34418`](eslint/eslint@3e34418) chore: Add new issues to triage project ([#&#8203;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.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMDIuNCIsInVwZGF0ZWRJblZlciI6IjM0LjEwMi43In0=-->

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>
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Jul 10, 2023
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jul 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion chore This change is not user-facing documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants