diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..e649170 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,18 @@ +Please fill out the below template as best you can. +-------------------------------------------------------- + +### Description of Issue +Describe the issue as best you can. Screenshots, logs, and stack traces can be very helpful! + +### System Configuration +#### Project Version + +#### Additional Details (optional) + +### Steps to Reproduce the Issue +1. Step 1 +1. Step 2 + +### Expected Outcomes +- Links can be styled as buttons +- Disabled links behave the same as disabled buttons diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..24e4f42 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +### Summary +Summarize the contents of the code changes in your pull request. Tag any open issues you believe to be resolved by this pull request. + +### Additional Details +If you have anything else that you think may be relevant to this issue, list it here. Additional information can help us better understand your changes and speed up the review process. + +Please add your name to the [CONTRIBUTORS.md] file. Adding your name to the [CONTRIBUTORS.md] file signifies agreement to all rights and reservations provided by the [License]. + +Thanks for contributing to jsonrpc-dispatch. + +[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md +[License]: ../blob/master/LICENSE diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5948d03..74cfffe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ Thanks. * Commit locally and push to your fork until you are happy with your contribution. * Make sure to add tests and verify all the tests are passing when merging upstream. * Add an entry to the [Changelog][4] accordingly. -* Please add your name to the CONTRIBUTORS.md file. Adding your name to the CONTRIBUTORS.md file signifies agreement to all rights and reservations provided by the [License][5]. +* Please add your name to the [CONTRIBUTORS.md][8] file. Adding your name to the [CONTRIBUTORS.md][8] file signifies agreement to all rights and reservations provided by the [License][5]. * [Squash related commits together][6]. * Open a [pull request][7]. * The pull request will be reviewed by the community and merged by the project committers. @@ -37,3 +37,4 @@ Thanks. [5]: ./LICENSE [6]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html [7]: https://help.github.com/articles/using-pull-requests +[8]: ./CONTRIBUTORS.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 4031632..0000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,12 +0,0 @@ -Before you log an issue, please review these guidelines to help ensure a smooth process for everyone. - -Thanks. - -* Please browse our [existing issues][1] before logging new issues. -* Check that the issue has not already been fixed in the `master` branch. -* Open an issue with a descriptive title and a summary. -* Please be as clear and explicit as you can in your description of the problem. -* Please state the version of Operating System, Browser, and JSONRPC you are using in the description. -* Include any relevant code in the issue summary. - -[1]: https://github.com/cerner/jsonrpc-dispatch/issues diff --git a/LICENSE b/LICENSE index c5c0669..d645695 100644 --- a/LICENSE +++ b/LICENSE @@ -187,7 +187,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright 2016 Cerner Corporation + Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/NOTICE b/NOTICE index da6c218..cd7fd35 100644 --- a/NOTICE +++ b/NOTICE @@ -1,13 +1,13 @@ - Copyright 2016 Cerner Innovation, Inc. +Copyright 2016 Cerner Innovation, Inc. - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index f3a1755..0000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,24 +0,0 @@ -Before you contribute, please review these guidelines to help ensure a smooth process for everyone. - -Thanks. - -* Read [how to properly contribute to open source projects on Github][1]. -* Fork the project. -* Use a feature branch. -* Write [good commit messages][2]. -* Use the same coding conventions as the rest of the project. -* Commit locally and push to your fork until you are happy with your contribution. -* Make sure to add tests and verify all the tests are passing when merging upstream. -* Add an entry to the [Changelog][3] accordingly. -* Please add your name to the [CONTRIBUTORS.md][7] file. Adding your name to the [CONTRIBUTORS.md][7] file signifies agreement to all rights and reservations provided by the [License][4]. -* [Squash related commits together][5]. -* Open a [pull request][6]. -* The pull request will be reviewed by the community and merged by the project committers. - -[1]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request -[2]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html -[3]: ./CHANGELOG.md -[4]: ./LICENSE -[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html -[6]: https://help.github.com/articles/using-pull-requests -[7]: ./CONTRIBUTORS.md diff --git a/README.md b/README.md index 92a91a9..4b54b8b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # JSONRPC Dispatch +[![NPM version](http://img.shields.io/npm/v/jsonrpc-dispatch.svg)](https://www.npmjs.org/package/jsonrpc-dispatch) [![Build Status](https://travis-ci.org/cerner/jsonrpc-dispatch.svg?branch=master)](https://travis-ci.org/cerner/jsonrpc-dispatch) JSONRPC is a module for managing [JSONRPC](http://json-rpc.org) requests and