You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# How to Contribute
2
2
3
-
Jest is one of Facebook's opensource 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.
3
+
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.
4
4
5
5
If you want an already configured online IDE to contribute to Jest, you can use [Gitpod](https://gitpod.io/#https://github.com/facebook/jest)!
6
6
@@ -18,7 +18,7 @@ We will do our best to keep `main` in good shape, with tests passing at all time
18
18
19
19
### Workflow and Pull Requests
20
20
21
-
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.
21
+
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.
22
22
23
23
_Before_ submitting a pull request, please make sure the following is done…
24
24
@@ -44,7 +44,7 @@ _Before_ submitting a pull request, please make sure the following is done…
44
44
python --version
45
45
```
46
46
47
-
1. Make sure you have a compatible version of `node` installed (As of October 29th 2021, `v16.x` is recommended).
47
+
1. Make sure you have a compatible version of `node` installed (As of October 29th, 2021, `v16.x` is recommended).
48
48
49
49
```sh
50
50
node -v
@@ -62,7 +62,7 @@ _Before_ submitting a pull request, please make sure the following is done…
62
62
yarn --version
63
63
```
64
64
65
-
On Windows `yarn install` may fail with `gyp ERR! build error`. One of possible solutions:
65
+
On Windows `yarn install` may fail with `gyp ERR! build error`. One of the possible solutions:
66
66
67
67
```sh
68
68
yarn global add windows-build-tools
@@ -100,7 +100,7 @@ For significant changes to the documentation or website and things like cleanup,
100
100
101
101
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.
102
102
103
-
Make sure to alphabetically order your entry based on package name. If you have changed multiple packages, separate them with a comma.
103
+
Make sure to alphabetically order your entry based on the package name. If you have changed multiple packages, separate them with a comma.
104
104
105
105
#### Testing
106
106
@@ -221,7 +221,7 @@ Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
221
221
## Code Conventions
222
222
223
223
- 2 spaces for indentation (no tabs).
224
-
- 80 character line length strongly preferred.
224
+
- 80 character line length is strongly preferred.
225
225
- Prefer `'` over `"`.
226
226
- ES6 syntax when possible.
227
227
- Use [TypeScript](https://www.typescriptlang.org/).
0 commit comments