Skip to content

Commit fa20b9d

Browse files
nzakasamareshsm
andauthored
docs: Clarify when to open an issue for a PR (#19974)
* docs: Clarify when to open an issue for a PR fixes #19922 * Apply feedback * Update docs/src/contribute/pull-requests.md Co-authored-by: Amaresh S M <[email protected]> --------- Co-authored-by: Amaresh S M <[email protected]>
1 parent 54920ed commit fa20b9d

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/src/contribute/pull-requests.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,20 @@ If you want to contribute to an ESLint repo, please use a GitHub pull request. T
1111

1212
## Getting Started
1313

14-
If you'd like to work on a pull request and you've never submitted code before, follow these steps:
14+
The ESLint project uses issues to track our work, so it's important to ensure that a proper issue is open:
1515

16-
1. Set up a [development environment](./development-environment).
17-
1. If you want to implement a breaking change or a change to the core, ensure there's an issue that describes what you're doing and the issue has been accepted. You can create a new issue or just indicate you're [working on an existing issue](./work-on-issue). Bug fixes, documentation changes, and other pull requests do not require an issue.
16+
- **If there is an existing issue,** follow the instructions on [work on issues](work-on-issue).
17+
- **If there isn't an existing issue,** then open one to describe the change you want to make. Use the appropriate issue template.
18+
- **Exceptions:** Small changes, such as bug fixes, documentation updates, or package upgrades don't require an issue. Make sure the pull request description explains clearly what it is you're doing and why.
1819

1920
After that, you're ready to start working on code.
2021

2122
## Working with Code
2223

24+
::: important
25+
If you'd like to work on a pull request and you've never submitted code before, make sure to set up a [development environment](./development-environment).
26+
:::
27+
2328
The process of submitting a pull request is fairly straightforward and generally follows the same pattern each time:
2429

2530
1. [Create a new branch](#step1).

0 commit comments

Comments
 (0)