Skip to content

Commit 9c7cfe3

Browse files
authored
docs: 'Source Code' content in 'Set up Development Environment' page (#16780)
* docs: 'Source Code' page into 'Set up Development Environment' Resolves #16775 * delete index content
1 parent ede5c64 commit 9c7cfe3

3 files changed

Lines changed: 26 additions & 58 deletions

File tree

docs/src/contribute/development-environment.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,16 @@ Go to <https://nodejs.org/> to download and install the latest stable version fo
1515

1616
Most of the installers already come with [npm](https://www.npmjs.com/) but if for some reason npm doesn't work on your system, you can install it manually using the instructions on the site.
1717

18-
## Step 2: Fork and checkout your own ESLint repository
18+
## Step 2: Fork and Checkout Your Own ESLint Repository
1919

2020
Go to <https://github.com/eslint/eslint> and click the "Fork" button. Follow the [GitHub documentation](https://help.github.com/articles/fork-a-repo) for forking and cloning.
2121

22+
Clone your fork:
23+
24+
```shell
25+
git clone https://github.com/<Your Github Username>/eslint
26+
```
27+
2228
Once you've cloned the repository, run `npm install` to get all the necessary dependencies:
2329

2430
```shell
@@ -28,7 +34,9 @@ npm install
2834

2935
You must be connected to the Internet for this step to work. You'll see a lot of utilities being downloaded.
3036

31-
## Step 3: Add the upstream source
37+
**Note:** It's a good idea to re-run `npm install` whenever you pull from the main repository to ensure you have the latest development dependencies.
38+
39+
## Step 3: Add the Upstream Source
3240

3341
The *upstream source* is the main ESLint repository where active development happens. While you won't have push access to upstream, you will have pull access, allowing you to pull in the latest code whenever you want.
3442

@@ -56,7 +64,7 @@ npm install -g generator-eslint
5664

5765
Please see the [generator documentation](https://github.com/eslint/generator-eslint) for instructions on how to use it.
5866

59-
## Step 5: Run the tests
67+
## Step 5: Run the Tests
6068

6169
Running the tests is the best way to ensure you have correctly set up your development environment. Make sure you're in the `eslint` directory and run:
6270

@@ -68,6 +76,21 @@ The testing takes a few minutes to complete. If any tests fail, that likely mean
6876

6977
## Reference Information
7078

79+
### Directory Structure
80+
81+
The ESLint directory and file structure is as follows:
82+
83+
* `bin` - executable files that are available when ESLint is installed
84+
* `conf` - default configuration information
85+
* `docs` - documentation for the project
86+
* `lib` - contains the source code
87+
* `formatters` - all source files defining formatters
88+
* `rules` - all source files defining rules
89+
* `tests` - the main unit test folder
90+
* `lib` - tests for the source code
91+
* `formatters` - tests for the formatters
92+
* `rules` - tests for the rules
93+
7194
### Workflow
7295

7396
Once you have your development environment installed, you can make and submit changes to the ESLint source files. Doing this successfully requires careful adherence to our [pull-request submission workflow](./pull-requests).

docs/src/contribute/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,6 @@ If you'd like to request a change other than a bug fix or new rule, this section
3434

3535
Learn about the architecture of the ESLint project.
3636

37-
## [Get the Source Code](source-code)
38-
39-
Before you can get started developing ESLint, you'll need to get a copy of the ESLint source code. This section explains how to do that and a little about the source code structure.
40-
4137
## [Set up a Development Environment](development-environment)
4238

4339
Developing for ESLint is a bit different than running it on the command line. This section shows you how to set up a development environment and get you ready to write code.

docs/src/contribute/source-code.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

0 commit comments

Comments
 (0)