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

Extract contributing instructions to separate file #893

Merged
merged 1 commit into from
Nov 20, 2020
Merged

Extract contributing instructions to separate file #893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Contributing

## How to run tests

```bash
yarn test
```

## How to generate the documentation

The contents of [API.md](API.md) are generated from comments in the source code.
To update API.md, run the following command:

```bash
yarn docs
```
12 changes: 1 addition & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,7 @@ file yet.
Contributing
------------------------------------------------------------------------------

### How to Run Tests

```bash
yarn test
```

### How to Generate the Documentation

```bash
yarn docs
```
See [CONTRIBUTING.md](CONTRIBUTING.md).

Related
------------------------------------------------------------------------------
Expand Down