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
Please note this issue tracker is not a help forum. We recommend using
2
-
[StackOverflow](https://stackoverflow.com/questions/tagged/jest) or our
3
-
[discord channel](https://discord.gg/MWRhKCj) for questions.
1
+
Please note this issue tracker is not a help forum. We recommend using [StackOverflow](https://stackoverflow.com/questions/tagged/jest) or our [discord channel](https://discord.gg/MWRhKCj) for questions.
Jest is one of Facebook's open source projects that is both under very active
4
-
development and is also being used to ship code to everybody on
5
-
[facebook.com](https://www.facebook.com). We're still working out the kinks to
6
-
make contributing to this project as easy and transparent as possible, but we're
7
-
not quite there yet. Hopefully this document makes the process for contributing
8
-
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.
9
4
10
5
## [Code of Conduct](https://code.facebook.com/codeofconduct)
11
6
12
-
Facebook has adopted a Code of Conduct that we expect project participants to
13
-
adhere to. Please read [the full text](https://code.facebook.com/codeofconduct)
14
-
so that you can understand what actions will and will not be tolerated.
7
+
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.facebook.com/codeofconduct) so that you can understand what actions will and will not be tolerated.
15
8
16
9
## Open Development
17
10
18
-
All work on Jest happens directly on [GitHub](/). Both core team members and
19
-
external contributors send pull requests which go through the same review
20
-
process.
11
+
All work on Jest happens directly on [GitHub](/). Both core team members and external contributors send pull requests which go through the same review process.
21
12
22
13
### `master` is unsafe
23
14
24
-
We will do our best to keep `master` in good shape, with tests passing at all
25
-
times. But in order to move fast, we will make API changes that your application
26
-
might not be compatible with. We will do our best to communicate these changes
27
-
and always version appropriately so you can lock into a specific version if need
28
-
be.
15
+
We will do our best to keep `master` in good shape, with tests passing at all times. But in order to move fast, we will make API changes that your application might not be compatible with. We will do our best to communicate these changes and always version appropriately so you can lock into a specific version if need be.
29
16
30
17
### Workflow and Pull Requests
31
18
32
-
The core team will be monitoring for pull requests. When we get one, we'll run
33
-
some Facebook-specific integration tests on it first. From here, we'll need to
34
-
get another person to sign off on the changes and then merge the pull request.
35
-
For API changes we may need to fix internal uses, which could cause some delay.
36
-
We'll do our best to provide updates and feedback throughout the process.
19
+
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.
37
20
38
21
_Before_ submitting a pull request, please make sure the following is done…
39
22
40
-
1. Fork the repo and create your branch from `master`. A guide on how to fork a
2. Jest uses [Yarn](https://code.facebook.com/posts/1840075619545360) for running development scripts. If you haven't already done so, please [install yarn](https://yarnpkg.com/en/docs/install).
56
36
57
-
3. Run `yarn install`. On Windows: To install
58
-
[Yarn](https://yarnpkg.com/en/docs/install#windows-tab) on Windows you may
59
-
need to download either node.js or Chocolatey<br />
37
+
3. Run `yarn install`. On Windows: To install [Yarn](https://yarnpkg.com/en/docs/install#windows-tab) on Windows you may need to download either node.js or Chocolatey<br />
60
38
61
39
```sh
62
40
yarn install
@@ -68,8 +46,7 @@ _Before_ submitting a pull request, please make sure the following is done…
68
46
yarn --version
69
47
```
70
48
71
-
4. If you've added code that should be tested, add tests. You can use watch
72
-
mode that continuously transforms changed files to make your life easier.
49
+
4. 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.
73
50
74
51
```sh
75
52
# in the background
@@ -78,10 +55,7 @@ _Before_ submitting a pull request, please make sure the following is done…
78
55
79
56
5. If you've changed APIs, update the documentation.
80
57
81
-
6. Ensure the test suite passes via `yarn test`. To run the test suite you may
82
-
need to install [Mercurial](https://www.mercurial-scm.org/) (`hg`). On
83
-
macOS, this can be done using [homebrew](http://brew.sh/):
84
-
`brew install hg`.
58
+
6. Ensure the test suite passes via `yarn test`. To run the test suite you may need to install [Mercurial](https://www.mercurial-scm.org/) (`hg`). On macOS, this can be done using [homebrew](http://brew.sh/): `brew install hg`.
85
59
86
60
```sh
87
61
brew install hg # maybe
@@ -92,35 +66,25 @@ _Before_ submitting a pull request, please make sure the following is done…
92
66
93
67
#### Additional Workflow for any changes made to website or docs
94
68
95
-
If you are making changes to the website or documentation, test the website
96
-
folder and run the server to check if your changes are being displayed
97
-
accurately.
69
+
If you are making changes to the website or documentation, test the website folder and run the server to check if your changes are being displayed accurately.
98
70
99
-
1. Locate to the website directory and install any website specific
100
-
dependencies by typing in `yarn`. Following steps are to be followed for
101
-
this purpose from the root directory.
71
+
1. Locate to the website directory and install any website specific dependencies by typing in `yarn`. Following steps are to be followed for this purpose from the root directory.
102
72
```sh
103
73
cd website # Only needed if you are not already in the website directory
104
74
yarn
105
75
yarn start
106
76
```
107
-
2. You can run a development server to check if the changes you made are being
108
-
displayed accurately by running `yarn start` in the website directory.
77
+
2. You can run a development server to check if the changes you made are being displayed accurately by running `yarn start` in the website directory.
109
78
110
79
### Contributor License Agreement (CLA)
111
80
112
-
In order to accept your pull request, we need you to submit a CLA. You only need
113
-
to do this once, so if you've done this for another Facebook open source
114
-
project, you're good to go. If you are submitting a pull request for the first
115
-
time, just let us know that you have completed the CLA and we can cross-check
116
-
with your GitHub username.
81
+
In order to accept your pull request, we need you to submit a CLA. You only need to do this once, so if you've done this for another Facebook open source project, you're good to go. If you are submitting a pull request for the first time, just let us know that you have completed the CLA and we can cross-check with your GitHub username.
117
82
118
83
[Complete your CLA here.](https://code.facebook.com/cla)
119
84
120
85
## How to try a development build of Jest in another project
121
86
122
-
To link `jest` on the command line to `jest-cli/bin/jest.js` in a development
123
-
build:
87
+
To link `jest` on the command line to `jest-cli/bin/jest.js` in a development build:
124
88
125
89
```sh
126
90
cd /path/to/your/Jest_clone/packages/jest-cli
@@ -148,11 +112,9 @@ cd /path/to/another/project
148
112
jest [options] # run jest-cli/bin/jest.js in the development build
149
113
```
150
114
151
-
* To decide whether to specify any options, see `test` under `scripts` in the
152
-
`package.json` file of the other project.
115
+
* To decide whether to specify any options, see `test` under `scripts` in the `package.json` file of the other project.
153
116
154
-
To unlink `jest` on the command line from `jest-cli/bin/jest.js` in a
155
-
development build:
117
+
To unlink `jest` on the command line from `jest-cli/bin/jest.js` in a development build:
156
118
157
119
```sh
158
120
yarn unlink jest-cli
@@ -162,25 +124,19 @@ yarn unlink jest-cli
162
124
163
125
### Where to Find Known Issues
164
126
165
-
We will be using GitHub Issues for our public bugs. We will keep a close eye on
166
-
this and try to make it clear when we have an internal fix in progress. Before
167
-
filing a new issue, try to make sure your problem doesn't already exist.
127
+
We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new issue, try to make sure your problem doesn't already exist.
168
128
169
129
### Reporting New Issues
170
130
171
-
The best way to get your bug fixed is to provide a reduced test case. Please
172
-
provide a public repository with a runnable example.
131
+
The best way to get your bug fixed is to provide a reduced test case. Please provide a public repository with a runnable example.
173
132
174
133
### Security Bugs
175
134
176
-
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
177
-
disclosure of security bugs. With that in mind, please do not file public
178
-
issues; go through the process outlined on that page.
135
+
Facebook has a [bounty program](https://www.facebook.com/whitehat/) forthe safe disclosure of security bugs. With thatin mind, please do not file public issues; go through the process outlined on that page.
179
136
180
137
## How to Get in Touch
181
138
182
-
* Discord - [#jest](https://discord.gg/MWRhKCj) on
183
-
[Reactiflux](http://www.reactiflux.com/)
139
+
* Discord - [#jest](https://discord.gg/MWRhKCj) on [Reactiflux](http://www.reactiflux.com/)
184
140
185
141
## Code Conventions
186
142
@@ -195,5 +151,4 @@ issues; go through the process outlined on that page.
195
151
196
152
## License
197
153
198
-
By contributing to Jest, you agree that your contributions will be licensed
199
-
under its MIT license.
154
+
By contributing to Jest, you agree that your contributions will be licensed under its MIT license.
0 commit comments