Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (30 loc) · 880 Bytes

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 880 Bytes

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 for development dependency management. Ensure you have it installed before continuing.

yarn

Running Tests

IMPORTANT Before run tests, you should create a qiniu.config.json in test directory with the following example content:

{
  "accessKey": "<Your qiniu AccessKey>",
  "secretKey": "<Your qiniu SecretKey>",
  "bucket": "<Your qiniu bucket name>",
  "baseURL": "<Your qiniu bucket baseURL>",
  "zone": "<Qiniu upload zone>"
}
yarn test

Building

yarn build