Skip to content

Commit 6eeadab

Browse files
SimenBthymikee
authored andcommitted
stop wrapping markdown (#6299)
1 parent 75831af commit 6eeadab

File tree

188 files changed

+4982
-14965
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

188 files changed

+4982
-14965
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
## 👉 [Please follow one of these issue templates](https://github.com/facebook/jest/issues/new/choose) 👈
22

3-
Note: to keep the backlog clean and actionable, issues may be immediately closed
4-
if they do not follow one of the above issue templates.
3+
Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ A clear and concise description of what you expected to happen.
1818

1919
## Link to repl or repo (highly encouraged)
2020

21-
Please provide either a [repl.it demo](https://repl.it/languages/jest) or a
22-
minimal repository on GitHub.
21+
Please provide either a [repl.it demo](https://repl.it/languages/jest) or a minimal repository on GitHub.
2322

2423
Issues without a reproduction link are likely to stall.
2524

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,10 @@ Please provide an example for how this feature would be used.
1818

1919
## Pitch
2020

21-
Why does this feature belong in the
22-
[Jest core platform](https://www.youtube.com/watch?v=NtjyeojAOBs)?
21+
Why does this feature belong in the [Jest core platform](https://www.youtube.com/watch?v=NtjyeojAOBs)?
2322

2423
Common feature proposals that do not typically make it to core:
2524

26-
* New matchers (see
27-
[jest-extended](https://github.com/jest-community/jest-extended))
25+
* New matchers (see [jest-extended](https://github.com/jest-community/jest-extended))
2826
* Changes to the default reporter (use custom reporters instead)
2927
* Changes to node/jsdom test environments (use custom environments instead)

.github/ISSUE_TEMPLATE/question.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,4 @@ For questions or help please see:
1212

1313
* [The Jest help page](https://facebook.github.io/jest/en/help.html)
1414
* [Our discord channel in Reactiflux](https://discord.gg/MWRhKCj)
15-
* The [jestjs](https://stackoverflow.com/questions/tagged/jestjs) tag on
16-
[StackOverflow](https://stackoverflow.com/questions/ask)
15+
* The [jestjs](https://stackoverflow.com/questions/tagged/jestjs) tag on [StackOverflow](https://stackoverflow.com/questions/ask)

.github/ISSUE_TEMPLATE/regression.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ A clear and concise description of what you expected to happen.
2424

2525
## Link to repl or repo (highly encouraged)
2626

27-
Please provide either a [repl.it demo](https://repl.it/languages/jest) or a
28-
minimal repository on GitHub.
27+
Please provide either a [repl.it demo](https://repl.it/languages/jest) or a minimal repository on GitHub.
2928

3029
Issues without a reproduction link are likely to stall.
3130

.github/SUPPORT.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
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.

CHANGELOG.md

Lines changed: 607 additions & 1263 deletions
Large diffs are not rendered by default.

CONTRIBUTING.md

Lines changed: 22 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,26 @@
11
# How to Contribute
22

3-
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.
94

105
## [Code of Conduct](https://code.facebook.com/codeofconduct)
116

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.
158

169
## Open Development
1710

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.
2112

2213
### `master` is unsafe
2314

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.
2916

3017
### Workflow and Pull Requests
3118

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.
3720

3821
_Before_ submitting a pull request, please make sure the following is done…
3922

40-
1. Fork the repo and create your branch from `master`. A guide on how to fork a
41-
repository: https://help.github.com/articles/fork-a-repo/
23+
1. Fork the repo and create your branch from `master`. A guide on how to fork a repository: https://help.github.com/articles/fork-a-repo/
4224

4325
Open terminal (e.g. Terminal, iTerm, Git Bash or Git Shell) and type:
4426

@@ -50,13 +32,9 @@ _Before_ submitting a pull request, please make sure the following is done…
5032

5133
Note: Replace `<your_username>` with your GitHub username
5234

53-
2. Jest uses [Yarn](https://code.facebook.com/posts/1840075619545360) for
54-
running development scripts. If you haven't already done so, please
55-
[install yarn](https://yarnpkg.com/en/docs/install).
35+
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).
5636
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 />
6038
6139
```sh
6240
yarn install
@@ -68,8 +46,7 @@ _Before_ submitting a pull request, please make sure the following is done…
6846
yarn --version
6947
```
7048

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.
7350
7451
```sh
7552
# in the background
@@ -78,10 +55,7 @@ _Before_ submitting a pull request, please make sure the following is done…
7855
7956
5. If you've changed APIs, update the documentation.
8057

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`.
8559

8660
```sh
8761
brew install hg # maybe
@@ -92,35 +66,25 @@ _Before_ submitting a pull request, please make sure the following is done…
9266
9367
#### Additional Workflow for any changes made to website or docs
9468
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.
9870
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.
10272
```sh
10373
cd website # Only needed if you are not already in the website directory
10474
yarn
10575
yarn start
10676
```
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.
10978
11079
### Contributor License Agreement (CLA)
11180
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.
11782
11883
[Complete your CLA here.](https://code.facebook.com/cla)
11984
12085
## How to try a development build of Jest in another project
12186
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:
12488
12589
```sh
12690
cd /path/to/your/Jest_clone/packages/jest-cli
@@ -148,11 +112,9 @@ cd /path/to/another/project
148112
jest [options] # run jest-cli/bin/jest.js in the development build
149113
```
150114
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.
153116
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:
156118
157119
```sh
158120
yarn unlink jest-cli
@@ -162,25 +124,19 @@ yarn unlink jest-cli
162124
163125
### Where to Find Known Issues
164126
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.
168128

169129
### Reporting New Issues
170130

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.
173132

174133
### Security Bugs
175134

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/) for the safe disclosure of security bugs. With that in mind, please do not file public issues; go through the process outlined on that page.
179136

180137
## How to Get in Touch
181138

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/)
184140

185141
## Code Conventions
186142

@@ -195,5 +151,4 @@ issues; go through the process outlined on that page.
195151
196152
## License
197153
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

Comments
 (0)