Skip to content

Commit e0c789a

Browse files
committed
docs: fix minor typos in CONTRIBUTING.md
1 parent cf7da1e commit e0c789a

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

CONTRIBUTING.md

+20-19
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,21 @@
22

33
## Table of Contents
44

5-
* [Introduction](#introduction)
6-
* [Code Structure](#code-structure)
7-
* [Running Tests](#running-tests)
8-
* [Debugging](#debugging)
9-
* [Coverage](#coverage)
10-
* [Benchmarking](#benchmarking)
11-
* [Types of Contributions](#types-of-contributions)
12-
* [Contributing an Issue?](#contributing-an-issue)
13-
* [Contributing a Question?](#contributing-a-question)
14-
* [Contributing a Bug Fix?](#contributing-a-bug-fix)
15-
* [Contributing a Feature?](#contributing-a-bug-feature)
16-
* [Development Dependencies](#development-dependencies)
17-
* [Dependencies](#dependencies)
5+
- [npm CLI Contributor Roles and Responsibilities](#npm-cli-contributor-roles-and-responsibilities)
6+
- [Table of Contents](#table-of-contents)
7+
- [Introduction](#introduction)
8+
- [Code Structure](#code-structure)
9+
- [Running Tests](#running-tests)
10+
- [Debugging](#debugging)
11+
- [Coverage](#coverage)
12+
- [Benchmarking](#benchmarking)
13+
- [Types of Contributions](#types-of-contributions)
14+
- [Contributing an Issue?](#contributing-an-issue)
15+
- [Contributing a Question?](#contributing-a-question)
16+
- [Contributing a Bug Fix?](#contributing-a-bug-fix)
17+
- [Contributing a Feature?](#contributing-a-feature)
18+
- [Development Dependencies](#development-dependencies)
19+
- [Dependencies](#dependencies)
1820

1921
## Introduction
2022

@@ -73,7 +75,7 @@ All interactions in the npm repository are covered by the [npm Code of Conduct](
7375
# Make sure you install the dependencies first before running tests.
7476
$ npm install
7577
76-
# Run tests for the CLI (it could take awhile).
78+
# Run tests for the CLI (it could take a while).
7779
$ npm run test
7880
```
7981

@@ -97,7 +99,7 @@ $ make link
9799
#################
98100
# ALTERNATIVELY
99101
#################
100-
# If ou're working on a feature or bug, you can run the same command on your
102+
# If you're working on a feature or bug, you can run the same command on your
101103
# working branch and link that code.
102104
103105
# Create new branch to work from (there are many ways)
@@ -123,14 +125,14 @@ We often want to know if the bug we've fixed for the feature we've added has any
123125
1. Make a pull-request against this repository
124126
2. Add the following comment to the pull-request: "`test this please ✅`"
125127

126-
This will trigger the [benmark suite](https://github.com/npm/benchmarks) to run against your pull-request, and when it's finished running it will post a comment on your pull-request just like bellow. You'll be able to see the results from the suite inline in your pull-request.
128+
This will trigger the [benchmark suite](https://github.com/npm/benchmarks) to run against your pull-request, and when it's finished running it will post a comment on your pull-request just like below. You'll be able to see the results from the suite inline in your pull-request.
127129

128130
> You'll notice that the bot-user will also add a 🚀 reaction to your comment to
129131
let you know that it's sent the request to start the benchmark suite.
130132

131133
![image](https://user-images.githubusercontent.com/2818462/72312698-e2e57f80-3656-11ea-9fcf-4a8f6b97b0d1.png)
132134

133-
If you've updated your pull-reuqest and you'd like to run the the benchmark suite again, simple update your original comment, by adding `test this please ✅` again, or simply just adding another emoji to the **end**. _(The trigger is the phrase "test this please ✅" at the beginning of a comment. Updates will trigger as well, so long as the phrase stays at the beginning.)_.
135+
If you've updated your pull-request and you'd like to run the the benchmark suite again, simple update your original comment, by adding `test this please ✅` again, or simply just adding another emoji to the **end**. _(The trigger is the phrase "test this please ✅" at the beginning of a comment. Updates will trigger as well, so long as the phrase stays at the beginning.)_.
134136

135137
![image](https://user-images.githubusercontent.com/2818462/72313006-ec231c00-3657-11ea-9bd9-227634d67362.png)
136138

@@ -186,7 +188,6 @@ You'll need a few things installed in order to update and test the CLI project d
186188

187189
> Package vendoring is commonly referred to as the case where dependent packages are stored in the same place as your project. That usually means you dependencies are checked into your source management system, such as Git.
188190
189-
The CLI project vendors it's dependencies in the `node_modules/` folder. Meaning all the dependencies that the CLI project uses are contained withing the project itself. This is represented by the `bundledDependencies` section in the root level `package.json` file. The main reason for this is because the `npm` CLI project is distributed with the NodeJS runtime and needs to work out of the box, which means all dependencies need to be available after the runtime is installed.
191+
The CLI project vendors its dependencies in the `node_modules/` folder. Meaning all the dependencies that the CLI project uses are contained withing the project itself. This is represented by the `bundledDependencies` section in the root level `package.json` file. The main reason for this is because the `npm` CLI project is distributed with the NodeJS runtime and needs to work out of the box, which means all dependencies need to be available after the runtime is installed.
190192

191193
There are a couple scripts created to help manage this process in the `scripts/` folder.
192-

0 commit comments

Comments
 (0)