Skip to content

Commit 001f896

Browse files
authored
Fixing grammar errors (nodejs#2852)
1 parent 0a6b066 commit 001f896

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ This project follows the [Conventional Commits][] specification.
5858

5959
Basic rules:
6060

61-
* Commit messages must be prefixed with the name of the changed subsystem, followed by a colon and a space and start with an imperative verb. Check the output of `git log --oneline files/you/changed` to find out what subsystems your changes touch.
61+
* Commit messages must be prefixed with the name of the changed subsystem, followed by a colon and a space, and start with an imperative verb. Check the output of `git log --oneline files/you/changed` to find out what subsystems your changes touch.
6262

6363
Supported subsystems:
6464

@@ -74,15 +74,15 @@ Basic rules:
7474

7575
* Pull Requests must be open for at least 48 hours unless changes include errata fixes, infrastructure maintenance, or tests
7676
* There must be no objections after a 48 hour period
77-
* Pull Requests for a new feature or bug fix must include tests
77+
* Tests must be included in Pull Requests for new features or bug fixes
7878

7979
The default for each contribution is that it is accepted once no collaborator has an objection. During review collaborators may also request that a specific contributor who is most versed in a particular area gives a "LGTM" before the PR can be merged.
8080

8181
In the case of an objection being raised in a pull request by another collaborator, all involved collaborators should seek to arrive at a consensus by way of addressing concerns being expressed by discussion, compromise on the proposed change, or withdrawal of the proposed change.
8282

8383
## When Landing
8484

85-
* Do not use merge button
85+
* Do not use the merge button
8686
* [`squash`][] pull-requests made up of multiple commits
8787
* Land how you like as long as there are no merge commits
8888

docs/project-overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ A quick look at some of the top-level files and directories found in this projec
77
1. **`/node_modules`**: The directory where all of the modules of code that your project depends on (npm packages) are automatically installed.
88
1. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser), like your site header, or a page template. "Src" is a convention for "source code."
99
1. **`/content`**: This directory contains all the contents of (pages, blog posts, doc pages) of the website. They're all done in Markdown and MDX.
10-
1. **`/test`**: Tests for this projects are stored in this directory. This project uses [Jest](https://jestjs.io/) as it's testing framework.
10+
1. **`/test`**: Tests for this projects are stored in this directory. This project uses [Jest](https://jestjs.io/) as its testing framework.
1111
1. **`/util-node`**: Custom utility functions that require nodeJs to run can be stored in files inside this directory. An example is the create-slug function in the createSlug.js file that generates unique slugs for articles.
1212
1. **`.gitignore`**: This file tells git which files it should not track/not maintain a version history.
1313
1. **`.nvmrc`**: nvm configuration so packages work as they should
1414
1. **`.prettierrc`**: This is a configuration file for a tool called [Prettier](https://prettier.io/), which is a tool to help keep the formatting of your code consistent.
1515
1. **`empty.env`**: Rename to **`.env`** and set your Contentful API key
1616
1. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.com/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
17-
1. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you'd like to include, etc. (Check out the [config docs](https://www.gatsbyjs.com/docs/reference/config-files/gatsby-config/) for more detail).
17+
1. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata), like the site title and description, which Gatsby plugins you'd like to include, etc. (Check out the [config docs](https://www.gatsbyjs.com/docs/reference/config-files/gatsby-config/) for more detail).
1818
1. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby node APIs](https://www.gatsbyjs.com/docs/reference/config-files/gatsby-node/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
1919
1. **`LICENSE`**: Gatsby is licensed under the MIT license.
2020
1. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won't change this file directly)
@@ -35,5 +35,5 @@ The content folder is responsible for aggregating all the content of the Website
3535

3636
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.com/). Here are some places to start:
3737

38-
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.com/docs/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
39-
- **To dive straight into code samples head [to our documentation](https://www.gatsbyjs.com/docs/).** In particular, check out the "Guides", API reference, and "Advanced Tutorials" sections in the sidebar.
38+
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.com/docs/tutorial/).** It starts with zero assumptions about your level of ability and walks you through every step of the process.
39+
- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.com/docs/).** In particular, check out the "Guides", "API Reference", and "Advanced Tutorials" sections in the sidebar.

0 commit comments

Comments
 (0)