From c969d27d033306e54cd317df76ebb83c9253e485 Mon Sep 17 00:00:00 2001 From: Tsuyoshi TAKAHASHI Date: Mon, 4 Dec 2017 17:17:10 +0900 Subject: [PATCH 1/2] add contribution guide to README --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/README.md b/README.md index 634a00ed..a6d6062e 100644 --- a/README.md +++ b/README.md @@ -72,3 +72,60 @@ After making changes in `src/`, you run - `npm test` to run tests then the `npm run build` and build `skyway(.min).js` which is stored in `dist` directory! + +### Bug Reports +* check if you can reproduce in the latest version +* check the [FAQ](https://support.skyway.io/hc/en-us/categories/204565748-FAQ) and the [forum](https://support.skyway.io/hc/en-us/community/topics) to make sure the same issue has not already been reported. +* create an issue by filling in the template. + +### Feature requests, proposals +* We welcome suggestions on the [developer community forums](https://support.skyway.io/hc/en-us/community/topics) +* GitHub issues are primarily intended for bug reports/fixes + +### Pull Requests +* We do our best to process them quickly but please be understanding if we take a while to respond. +* Steps + * make changes on your fork. + * include clear descriptions and references to all the issues by filling the template. + * submit tests for your changes. + * update docs when creating or changing features. + * make sure the test suite & lint passes. + +``` +npm run lint +npm run test +``` + +* Branch + * send all pull requests (bug fixes, new features) to the master branch. + * maintainers will change it to an appropriate branch. + +### Templates +#### Issue +``` +## Description of the problem + +## Environment +- SDK version (ex. SDK v1.0.1,etc) +- Device (ex. Windows PC, Nexus6, etc) +- OS (ex. Windows XX / Android 7.0 etc) +- Network (Cable/DSL/Fiber + WiFi, MiFi, LTE, etc) + +## Steps to reproduce the problem + +## Expected behavior + +## Other information (Console log etc) + +``` +#### PR +``` +## Description of the Change + +## Benefits + +## Possible side effects + +## Relevant Issues + +``` From 45ea4ab7f60c79f8464b1c8a67434c09d969ce37 Mon Sep 17 00:00:00 2001 From: Tsuyoshi TAKAHASHI Date: Mon, 4 Dec 2017 17:39:10 +0900 Subject: [PATCH 2/2] update changelog and version in package.json to 1.1.2 --- CHANGELOG.md | 6 ++++++ package.json | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a335f5b3..b446f819 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## [v1.1.2](https://github.com/skyway/skyway-js-sdk/releases/tag/v1.1.2) - 2017-12-04 + +### Added + +- Added contribution guide to README + ## [v1.1.1](https://github.com/skyway/skyway-js-sdk/releases/tag/v1.1.1) - 2017-12-04 ### Fixed diff --git a/package.json b/package.json index ec4021ee..1f1e666e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "skyway-js", - "version": "1.1.1", + "version": "1.1.2", "description": "The official JavaScript SDK for SkyWay", "main": "dist/skyway.js", "module": "src/peer.js",