-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
50 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Contributing | ||
|
||
## Issues | ||
|
||
Please provide a minimal, reproducible test-case. | ||
|
||
|
||
## Pull Requests | ||
|
||
Follow the instructions on the Pull Request Template (shown when you open a new PR) and make sure you've done the following: | ||
|
||
- [ ] Add & update tests | ||
- [ ] Update relevant documentation and/or examples | ||
|
||
|
||
## Setup | ||
|
||
This package uses [yarn](https://yarnpkg.com) for development dependency management. Ensure you have it installed before continuing. | ||
|
||
```sh | ||
yarn | ||
``` | ||
|
||
## Running Tests | ||
|
||
**IMPORTANT** Before run tests, you should create a `qiniu.config.json` in `test` directory with the following example content: | ||
|
||
```json | ||
{ | ||
"accessKey": "<Your qiniu AccessKey>", | ||
"secretKey": "<Your qiniu SecretKey>", | ||
"bucket": "<Your qiniu bucket name>", | ||
"baseURL": "<Your qiniu bucket baseURL>", | ||
"zone": "<Qiniu upload zone>" | ||
} | ||
``` | ||
|
||
```sh | ||
yarn test | ||
``` | ||
|
||
|
||
## Building | ||
|
||
```sh | ||
yarn build | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters