Skip to content

Commit

Permalink
stop wrapping markdown (#6299)
Browse files Browse the repository at this point in the history
  • Loading branch information
SimenB authored and thymikee committed May 27, 2018
1 parent 75831af commit 6eeadab
Show file tree
Hide file tree
Showing 188 changed files with 4,982 additions and 14,965 deletions.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
## 👉 [Please follow one of these issue templates](https://github.com/facebook/jest/issues/new/choose) 👈

Note: to keep the backlog clean and actionable, issues may be immediately closed
if they do not follow one of the above issue templates.
Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ A clear and concise description of what you expected to happen.

## Link to repl or repo (highly encouraged)

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

Issues without a reproduction link are likely to stall.

Expand Down
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,10 @@ Please provide an example for how this feature would be used.

## Pitch

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

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

* New matchers (see
[jest-extended](https://github.com/jest-community/jest-extended))
* New matchers (see [jest-extended](https://github.com/jest-community/jest-extended))
* Changes to the default reporter (use custom reporters instead)
* Changes to node/jsdom test environments (use custom environments instead)
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,4 @@ For questions or help please see:

* [The Jest help page](https://facebook.github.io/jest/en/help.html)
* [Our discord channel in Reactiflux](https://discord.gg/MWRhKCj)
* The [jestjs](https://stackoverflow.com/questions/tagged/jestjs) tag on
[StackOverflow](https://stackoverflow.com/questions/ask)
* The [jestjs](https://stackoverflow.com/questions/tagged/jestjs) tag on [StackOverflow](https://stackoverflow.com/questions/ask)
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/regression.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ A clear and concise description of what you expected to happen.

## Link to repl or repo (highly encouraged)

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

Issues without a reproduction link are likely to stall.

Expand Down
4 changes: 1 addition & 3 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,3 +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.
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.
1,870 changes: 607 additions & 1,263 deletions CHANGELOG.md

Large diffs are not rendered by default.

89 changes: 22 additions & 67 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,26 @@
# 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.

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

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

## Open Development

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

### `master` is unsafe

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

### 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 delay. 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…

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

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

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

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

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).
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).
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 />
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 />
```sh
yarn install
Expand All @@ -68,8 +46,7 @@ _Before_ submitting a pull request, please make sure the following is done…
yarn --version
```

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

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

```sh
brew install hg # maybe
Expand All @@ -92,35 +66,25 @@ _Before_ submitting a pull request, please make sure the following is done…
#### Additional Workflow for any changes made to website or docs
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.
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.
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.
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.
```sh
cd website # Only needed if you are not already in the website directory
yarn
yarn start
```
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.
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.
### Contributor License Agreement (CLA)
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.
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.
[Complete your CLA here.](https://code.facebook.com/cla)
## How to try a development build of Jest in another project
To link `jest` on the command line to `jest-cli/bin/jest.js` in a development
build:
To link `jest` on the command line to `jest-cli/bin/jest.js` in a development build:
```sh
cd /path/to/your/Jest_clone/packages/jest-cli
Expand Down Expand Up @@ -148,11 +112,9 @@ cd /path/to/another/project
jest [options] # run jest-cli/bin/jest.js in the development build
```
* To decide whether to specify any options, see `test` under `scripts` in the
`package.json` file of the other project.
* To decide whether to specify any options, see `test` under `scripts` in the `package.json` file of the other project.
To unlink `jest` on the command line from `jest-cli/bin/jest.js` in a
development build:
To unlink `jest` on the command line from `jest-cli/bin/jest.js` in a development build:
```sh
yarn unlink jest-cli
Expand All @@ -162,25 +124,19 @@ yarn unlink jest-cli
### Where to Find Known Issues
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.
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.

### Reporting New Issues

The best way to get your bug fixed is to provide a reduced test case. Please
provide a public repository with a runnable example.
The best way to get your bug fixed is to provide a reduced test case. Please provide a public repository with a runnable example.

### Security Bugs

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

## How to Get in Touch

* Discord - [#jest](https://discord.gg/MWRhKCj) on
[Reactiflux](http://www.reactiflux.com/)
* Discord - [#jest](https://discord.gg/MWRhKCj) on [Reactiflux](http://www.reactiflux.com/)

## Code Conventions

Expand All @@ -195,5 +151,4 @@ issues; go through the process outlined on that page.
## License
By contributing to Jest, you agree that your contributions will be licensed
under its MIT license.
By contributing to Jest, you agree that your contributions will be licensed under its MIT license.
Loading

0 comments on commit 6eeadab

Please sign in to comment.