Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note about Python dependency in CONTRIBUTING #6967

Merged
merged 2 commits into from
Sep 12, 2018
Merged

Add note about Python dependency in CONTRIBUTING #6967

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa18e0a
Add note about Python dependency in CONTRIBUTING
ollelauribostrom Sep 12, 2018
f7b0436
Update CONTRIBUTING.md
SimenB Sep 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,16 @@ _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).
1. 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 />
1. Make sure you have `python` installed (v2.7 is recommended, v3.x.x is not supported). Python is required by [node-gyp](https://github.com/nodejs/node-gyp) that is used when running `yarn install`.

To check your version of Python and ensure it's installed you can type:
```
python --version
```

1. 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 @@ -46,23 +53,23 @@ _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.
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
yarn run watch
```

5. If you've changed APIs, update the documentation.
1. 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`.
1. 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
yarn test
```

7. If you haven't already, complete the CLA.
1. If you haven't already, complete the CLA.

#### Additional Workflow for any changes made to website or docs

Expand All @@ -74,7 +81,7 @@ If you are making changes to the website or documentation, test the website fold
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.
1. 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)

Expand Down