This repository has been archived by the owner on Mar 11, 2022. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Updated issue and PR templates * Updated CONTRIBUTING information
- Loading branch information
Showing
3 changed files
with
199 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,23 @@ | ||
Please include the following information in your ticket. | ||
Please [read these guidelines](http://ibm.biz/cdt-issue-guide) before opening an issue. | ||
|
||
- CDTDatastore version(s) that are affected by this issue. | ||
<!-- Issues will be CLOSED IMMEDIATELY if the following template is not completed. --> | ||
|
||
## Bug Description | ||
|
||
### 1. Steps to reproduce and the simplest code sample possible to demonstrate the issue | ||
<!-- | ||
Outline the steps you take to make the problem happen. | ||
Provide the simplest code sample you can, in context, that reproduces the issue. | ||
--> | ||
|
||
### 2. What you expected to happen | ||
|
||
### 3. What actually happened | ||
|
||
## Environment details | ||
<!-- | ||
- Version(s) that are affected by this issue. | ||
> 2.0.2 | ||
- iOS/macOS version | ||
- A small code sample that demonstrates the issue. | ||
> macOS 10.13.1 | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,102 @@ | ||
<!-- | ||
Thanks for your hard work, please ensure all items are complete before opening. | ||
--> | ||
## Checklist | ||
|
||
- [ ] Tick to sign-off your agreement to the [Developer Certificate of Origin (DCO) 1.1](https://github.com/cloudant/CDTDatastore/blob/master/DCO1.1.txt) | ||
- [ ] You have added tests for any code changes | ||
- [ ] You have updated the [CHANGELOG.md](https://github.com/cloudant/CDTDatastore/blob/master/CHANGELOG.md) | ||
- [ ] You have completed the PR template below: | ||
- [ ] Tick to sign-off your agreement to the [Developer Certificate of Origin (DCO) 1.1](../blob/master/DCO1.1.txt) | ||
- [ ] Added tests for code changes _or_ test/build only changes | ||
- [ ] Updated the change log file (`CHANGES.md`|`CHANGELOG.md`) _or_ test/build only changes | ||
- [ ] Completed the PR template below: | ||
|
||
## What | ||
## Description | ||
<!-- | ||
Provide a short description; saving the detail for the `Approach` section | ||
What was changed e.g. | ||
>Fix bug for handling queries like { "$not" : { "$size" : 1} }. | ||
Also EITHER: | ||
Link to issue this PR is resolving, use the Fixes #nnn form so that the | ||
issue closes automatically when the PR merges e.g.: | ||
## How | ||
Fixes #23 | ||
How the change was implemented and reasoning behind it, e.g. | ||
>Added recursion logic to handle size operator in negated clause. | ||
OR | ||
For PRs without an associated issue and/or test/build issues | ||
### 1. Steps to reproduce and the simplest code sample possible to demonstrate the issue | ||
### 2. What you expected to happen | ||
### 3. What actually happened | ||
--> | ||
|
||
## Approach | ||
|
||
<!-- | ||
Be brief: which component(s) of the code base does the fix focus on. | ||
A place to note whether the part of the code base that is being worked is | ||
particularly sensitive. | ||
--> | ||
|
||
## Schema & API Changes | ||
|
||
<!-- | ||
EITHER: | ||
- "No change" | ||
OR | ||
For public API (as opposed to internal) changes | ||
- "Fixing bug in API, will change x in such-and-such way" | ||
--> | ||
|
||
## Security and Privacy | ||
|
||
<!-- | ||
EITHER: | ||
- "No change" | ||
OR | ||
"Making changes in e.g. auth|https|encryption|io | ||
need to be careful about..." | ||
--> | ||
|
||
## Testing | ||
|
||
How to test your changes work, not required for documentation changes. | ||
<!-- | ||
EITHER: | ||
- Added new tests: | ||
- test x | ||
- test y | ||
- test z | ||
OR | ||
- Modified existing tests because ... | ||
OR | ||
- N/A build or packaging only changes | ||
OR | ||
In exceptional circumstances there may be a good reason we can't add automated | ||
tests, for example if a specific device is required to reproduce a problem. | ||
- No new tests because... | ||
--> | ||
|
||
## Monitoring and Logging | ||
<!-- | ||
EITHER: | ||
- "No change" | ||
## Issues | ||
OR | ||
Links to the github issue(s) (if present) that this pull request is resolving. | ||
- "Added new log line X..." | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters