From ed01af8b8a10da84ef49b8d16a3e38da19c7d231 Mon Sep 17 00:00:00 2001 From: Shrey <53387208+shreykinshu@users.noreply.github.com> Date: Sun, 29 May 2022 01:45:45 +0530 Subject: [PATCH 1/2] Grammatically updated the contribution.md --- CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bdb96e0c6bfd..e30ab95356db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # How to Contribute -Jest is one of Facebook's open source projects that is both under very active development and is also being used to ship code to everybody on [facebook.com](https://www.facebook.com). We're still working out the kinks to make contributing to this project as easy and transparent as possible, but we're not quite there yet. Hopefully this document makes the process for contributing clear and answers some questions that you may have. +Jest is one of Facebook's open-source projects that is both under very active development and is also being used to ship code to everybody on [Facebook.com](https://www.facebook.com). We're still working out the kinks to make contributing to this project as easy and transparent as possible, but we're not quite there yet. Hopefully, this document makes the process for contributing clear and answers some questions that you may have. If you want an already configured online IDE to contribute to Jest, you can use [Gitpod](https://gitpod.io/#https://github.com/facebook/jest)! @@ -18,7 +18,7 @@ We will do our best to keep `main` in good shape, with tests passing at all time ### Workflow and Pull Requests -The core team will be monitoring for pull requests. When we get one, we'll run some Facebook-specific integration tests on it first. From here, we'll need to get another person to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, which could cause some delay. We'll do our best to provide updates and feedback throughout the process. +The core team will be monitoring for pull requests. When we get one, we'll run some Facebook-specific integration tests on it first. From here, we'll need to get another person to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, which could cause some delays. We'll do our best to provide updates and feedback throughout the process. _Before_ submitting a pull request, please make sure the following is done… @@ -44,7 +44,7 @@ _Before_ submitting a pull request, please make sure the following is done… python --version ``` -1. Make sure you have a compatible version of `node` installed (As of October 29th 2021, `v16.x` is recommended). +1. Make sure you have a compatible version of `node` installed (As of October 29th, 2021, `v16.x` is recommended). ```sh node -v @@ -62,7 +62,7 @@ _Before_ submitting a pull request, please make sure the following is done… yarn --version ``` - On Windows `yarn install` may fail with `gyp ERR! build error`. One of possible solutions: + On Windows `yarn install` may fail with `gyp ERR! build error`. One of the possible solution: ```sh yarn global add windows-build-tools @@ -74,7 +74,7 @@ _Before_ submitting a pull request, please make sure the following is done… yarn build ``` -1. If you've added code that should be tested, add tests. You can use watch mode that continuously transforms changed files to make your life easier. +1. If you've added code that should be tested, add tests. You can use a watch mode that continuously transforms changed files to make your life easier. ```sh # in the background @@ -100,7 +100,7 @@ For significant changes to the documentation or website and things like cleanup, You can add or edit the changelog entry in the GitHub web interface once you have opened the pull request and know the number and link to it. -Make sure to alphabetically order your entry based on package name. If you have changed multiple packages, separate them with a comma. +Make sure to alphabetically order your entry based on the package name. If you have changed multiple packages, separate them with a comma. #### Testing @@ -221,7 +221,7 @@ Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe ## Code Conventions - 2 spaces for indentation (no tabs). -- 80 character line length strongly preferred. +- 80 character line length is strongly preferred. - Prefer `'` over `"`. - ES6 syntax when possible. - Use [TypeScript](https://www.typescriptlang.org/). From 0464a6b1b094df752e09ba415c1d357f484f4ac7 Mon Sep 17 00:00:00 2001 From: Simen Bekkhus Date: Thu, 2 Jun 2022 13:44:12 +0200 Subject: [PATCH 2/2] Apply suggestions from code review --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e30ab95356db..aa0ccdb5b328 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,7 +62,7 @@ _Before_ submitting a pull request, please make sure the following is done… yarn --version ``` - On Windows `yarn install` may fail with `gyp ERR! build error`. One of the possible solution: + On Windows `yarn install` may fail with `gyp ERR! build error`. One of the possible solutions: ```sh yarn global add windows-build-tools @@ -74,7 +74,7 @@ _Before_ submitting a pull request, please make sure the following is done… yarn build ``` -1. If you've added code that should be tested, add tests. You can use a watch mode that continuously transforms changed files to make your life easier. +1. If you've added code that should be tested, add tests. You can use watch mode that continuously transforms changed files to make your life easier. ```sh # in the background