diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..5c3c01c --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,5 @@ +Please include the following information in your ticket. + +- cloudant-sync (sync-cordova-plugin) version(s) that are affected by this issue. +- Apache Cordova version and platform. +- A small code sample that demonstrates the issue. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..a32124e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,24 @@ +Thanks for your hard work, please ensure all items are complete before opening a PR. + +- [ ] Tick to sign-off your agreement to the [Developer Certificate of Origin (DCO) 1.1](https://github.com/cloudant/sync-cordova-plugin/blob/master/DCO1.1.txt) +- [ ] You have [added tests](https://github.com/cloudant/sync-cordova-plugin/blob/master/CONTRIBUTING.md#adding-tests) for any code changes +- [ ] You have updated the [CHANGES.md](https://github.com/cloudant/sync-cordova-plugin/blob/master/CHANGES.md) +- [ ] You have completed the PR template below: + +## What + +What was changed, e.g. +>Updated sync-android version + +## How + +How the change was implemented and reasoning behind it, e.g. +>Updated the sync-extras.gradle + +## Testing + +How to test your changes work, not required for documentation changes. + +## Issues + +Links to the github issue(s) (if present) that this pull request is resolving. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ccfeff..80b02ee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,25 +2,18 @@ Cloudant-sync is a cordova plug-in which wraps [Cloudant Sync - Android Datastore](https://github.com/cloudant/sync-android) And [CDTDatastore](https://github.com/cloudant/CDTDatastore). -## Contributor License Agreement +## Developer Certificate of Origin -In order for us to accept pull-requests, the contributor must first complete -a Contributor License Agreement (CLA). This clarifies the intellectual -property license granted with any contribution. It is for your protection as a -Contributor as well as the protection of IBM and its customers; it does not -change your rights to use your own Contributions for any other purpose. +In order for us to accept pull-requests, the contributor must sign-off a +[Developer Certificate of Origin (DCO)](DCO1.1.txt). This clarifies the +intellectual property license granted with any contribution. It is for your +protection as a Contributor as well as the protection of IBM and its customers; +it does not change your rights to use your own Contributions for any other purpose. -This is a quick process: one option is signing using Preview on a Mac, -then sending a copy to us via email. Signing this agreement covers a few repos -as mentioned in the appendix of the CLA. +Please read the agreement and acknowledge it by ticking the appropriate box in the PR + text, for example: -You can download the CLAs here: - - - [Individual](http://cloudant.github.io/cloudant-sync-eap/cla/cla-individual.pdf) - - [Corporate](http://cloudant.github.io/cloudant-sync-eap/cla/cla-corporate.pdf) - -If you are an IBMer, please contact us directly as the contribution process is -slightly different. +- [x] Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1 ## Requirements - [Node.js](https://nodejs.org) diff --git a/DCO1.1.txt b/DCO1.1.txt new file mode 100644 index 0000000..f440e6f --- /dev/null +++ b/DCO1.1.txt @@ -0,0 +1,25 @@ +Developer's Certificate of Origin 1.1 + + By making a contribution to this project, I certify that: + + (a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + + (b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + + (c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + + (d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved.