Skip to content

Commit

Permalink
add contributing info
Browse files Browse the repository at this point in the history
  • Loading branch information
Cap32 committed Dec 12, 2017
1 parent 89e5054 commit 3c19c4a
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 15 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
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
```
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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": "<Your qiniu AccessKey>",
"secretKey": "<Your qiniu SecretKey>",
"bucket": "<Your qiniu bucket name>",
"baseURL": "<Your qiniu bucket baseURL>",
"zone": "<Your qiniu save 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
Expand Down

0 comments on commit 3c19c4a

Please sign in to comment.