Skip to content

Docs: Make issue requirement for PRs more clear #19922

@ST-DDT

Description

@ST-DDT

Docs page(s)

https://eslint.org/docs/latest/contribute/pull-requests#getting-started

What documentation issue do you want to solve?

I read the page, but I got confused whether I need to submit an issue first or not.
What does count as core?

What do you think is the correct solution?

Move the issue requirement to first place (since there is no point in setting up the development environment if the issues doesn't get accepted (for a time)) and put issue part to the front of the point, so it doesn't get overshaddowed by technicalities.

  • Create an issue and wait for the issue to get accepted
    If you want to implement a breaking change or a change to the core (e.g. lib)
    You can create a new issue or just indicate you’re working on an existing issue.
    Bug fixes, documentation changes, and other pull requests do not require an issue.
  • Set up a development environment.

It might be easier if we drop the list approach and use plain text instead, the issue text is quite long already.

Create an Issue (If Needed)

If you're planning to implement a breaking change or make changes to the core code (e.g., the lib directory), please create a new issue and wait for it to be accepted before starting work.

You can either open a new issue or indicate that you're working on an existing one.

For bug fixes, documentation updates, and other non-breaking changes, you can open a pull request directly—no issue is required.

Participation

  • I am willing to submit a pull request for this change.

Additional comments

While I'm willing to create a PR for this, I'm not exactly strong with words, so it might be better if someone else provides the phrases or the entire PR.


Ref:

Metadata

Metadata

Assignees

Labels

acceptedThere is consensus among the team that this change meets the criteria for inclusiondocumentationRelates to ESLint's documentation

Type

No type

Projects

Status

Complete

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions