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

docs: Remove old Markdown issue template #15556

Merged
merged 2 commits into from Feb 2, 2022
Merged

Conversation

btmills
Copy link
Member

@btmills btmills commented Feb 1, 2022

Prerequisites checklist

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

[ ] 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
[x] Other, please explain: Remove unused issue template

What changes did you make? (Give an overview)

This template in Markdown format has been superseded by the forms in the .github./ISSUE_TEMPLATE directory. When viewing this file in the GitHub UI, it shows a warning:

You are using an old version of issue templates. Please update to the new issue template workflow. Learn more

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

The old issue creation page can still be accessed by navigating directly to https://github.com/eslint/eslint/issues/new/, but I'm not able to find any links to it within the UI. Are we okay with that?

This template in Markdown format has been superseded by the forms in the
`.github./ISSUE_TEMPLATE` directory. When viewing this file in the
GitHub UI, it shows a warning:

> You are using an old version of issue templates. Please update to the
> new issue template workflow. [Learn more][1]

[1]: https://docs.github.com/articles/about-issue-and-pull-request-templates
@btmills btmills added the chore This change is not user-facing label Feb 1, 2022
@mdjermanovic
Copy link
Member

The old issue creation page can still be accessed by navigating directly to https://github.com/eslint/eslint/issues/new/, but I'm not able to find any links to it within the UI. Are we okay with that?

There's a link on eslint.org, on this page: https://eslint.org/docs/developer-guide/contributing/reporting-bugs

If you think you've found a bug in ESLint, please [create a new issue](https://github.com/eslint/eslint/issues/new) or a [pull request](/docs/developer-guide/contributing/pull-requests.md) on GitHub.

We should probably change all links that are meant to open a new issue to just open https://github.com/eslint/eslint/issues/new/choose

All of these direct links to our old Markdown-based issue templates are
broken and just lead to an empty form. I could link directly to the
relevant new yml template, but standardizing on `/issues/new/choose`
seems safer as it'll continue working even if we change the available
templates.
@btmills
Copy link
Member Author

btmills commented Feb 2, 2022

Good catch @mdjermanovic. In 95f5c0f, I updated all new issue links in the docs to point to the chooser. I could link directly to the relevant form, but standardizing on /issues-new/choose seems safer as it'll continue working even if we change the available templates.

We do not need to split this change across multiple commits to first update the website and then remove the old template because all of the documentation links are already broken and lead to an empty issue input where our old Markdown templates used to be.

@mdjermanovic mdjermanovic added the accepted There is consensus among the team that this change meets the criteria for inclusion label Feb 2, 2022
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!

@mdjermanovic mdjermanovic changed the title chore: Remove old Markdown issue template docs: Remove old Markdown issue template Feb 2, 2022
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Feb 2, 2022
@mdjermanovic mdjermanovic merged commit 0383591 into main Feb 2, 2022
@mdjermanovic mdjermanovic deleted the remove-old-issue-template branch February 2, 2022 11:04
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Feb 17, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.8.0` -> `8.9.0`](https://renovatebot.com/diffs/npm/eslint/8.8.0/8.9.0) |

---

### Release Notes

<details>
<summary>eslint/eslint</summary>

### [`v8.9.0`](https://github.com/eslint/eslint/releases/v8.9.0)

[Compare Source](eslint/eslint@v8.8.0...v8.9.0)

#### Features

-   [`68f64a9`](eslint/eslint@68f64a9) feat: update eslint-scope to ignore `"use strict"` directives in ES3 ([#&#8203;15595](eslint/eslint#15595)) (Milos Djermanovic)
-   [`db57639`](eslint/eslint@db57639) feat: add `es2016`, `es2018`, `es2019`, and `es2022` environments ([#&#8203;15587](eslint/eslint#15587)) (Milos Djermanovic)
-   [`2dc38aa`](eslint/eslint@2dc38aa) feat: fix bug with arrow function return types in function-paren-newline ([#&#8203;15541](eslint/eslint#15541)) (Milos Djermanovic)
-   [`6f940c3`](eslint/eslint@6f940c3) feat: Implement FlatRuleTester ([#&#8203;15519](eslint/eslint#15519)) (Nicholas C. Zakas)

#### Documentation

-   [`570a036`](eslint/eslint@570a036) docs: add `one-var` example with `for-loop` initializer ([#&#8203;15596](eslint/eslint#15596)) (Milos Djermanovic)
-   [`417191d`](eslint/eslint@417191d) docs: Remove the $ prefix in terminal commands ([#&#8203;15565](eslint/eslint#15565)) (Andreas Lewis)
-   [`389ff34`](eslint/eslint@389ff34) docs: add missing `Variable#scope` property in the scope manager docs ([#&#8203;15571](eslint/eslint#15571)) (Milos Djermanovic)
-   [`f63795d`](eslint/eslint@f63795d) docs: no-eval replace dead link with working one ([#&#8203;15568](eslint/eslint#15568)) (rasenplanscher)
-   [`0383591`](eslint/eslint@0383591) docs: Remove old Markdown issue template ([#&#8203;15556](eslint/eslint#15556)) (Brandon Mills)
-   [`a8dd5a2`](eslint/eslint@a8dd5a2) docs: add 'when not to use it' section in no-duplicate-case docs ([#&#8203;15563](eslint/eslint#15563)) (Milos Djermanovic)
-   [`1ad439e`](eslint/eslint@1ad439e) docs: add missed verb in docs ([#&#8203;15550](eslint/eslint#15550)) (Jeff Mosawy)

#### Chores

-   [`586d45c`](eslint/eslint@586d45c) chore: Upgrade to espree@9.3.1 ([#&#8203;15600](eslint/eslint#15600)) (Milos Djermanovic)
-   [`623e1e2`](eslint/eslint@623e1e2) chore: Upgrade to eslint-visitor-keys@3.3.0 ([#&#8203;15599](eslint/eslint#15599)) (Milos Djermanovic)
-   [`355b23d`](eslint/eslint@355b23d) chore: fix outdated link to Code of Conduct in PR template ([#&#8203;15578](eslint/eslint#15578)) (Rich Trott)
-   [`b10fef2`](eslint/eslint@b10fef2) ci: use Node 16 for browser test ([#&#8203;15569](eslint/eslint#15569)) (Milos Djermanovic)
-   [`92f89fb`](eslint/eslint@92f89fb) chore: suggest demo link in bug report template ([#&#8203;15557](eslint/eslint#15557)) (Brandon Mills)

</details>

---

### Configuration

📅 **Schedule**: 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, click this checkbox.

---

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/1173
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 Aug 2, 2022
@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 Aug 2, 2022
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

3 participants