diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..70773ce --- /dev/null +++ b/CONTRIBUTING.md @@ -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": "", + "secretKey": "", + "bucket": "", + "baseURL": "", + "zone": "" +} +``` + +```sh +yarn test +``` + + +## Building + +```sh +yarn build +``` diff --git a/README.md b/README.md index 2b0b142..1947f00 100644 --- a/README.md +++ b/README.md @@ -115,26 +115,14 @@ Please checkout https://developer.qiniu.com/kodo/manual/1671/region-endpoint for - If you are looking for a react component, [tiny-qiniu-request](https://github.com/die-welle/tiny-qiniu-request) is a good helper -## Testing +## Contributing -For more usage, please check the `./test` directory, or clone this repo and run `npm test` to start testing. - -**IMPORTANT** Before run `npm test`, you should create a `qiniu.config.json` on `test` directory with the following example content: - -```json -{ - "accessKey": "", - "secretKey": "", - "bucket": "", - "baseURL": "", - "zone": "" -} -``` +[Please checkout the contributing page](/CONTRIBUTING.md) ## ChangeLog -[Please checkout the Releases page](/releases) +[Please checkout the Releases page](https://github.com/die-welle/tiny-qiniu/releases) ## License