Skip to content
This repository was archived by the owner on Jul 22, 2021. It is now read-only.

Commit 2416de7

Browse files
ricellisricellis
authored
Template updates (#9)
* Updated issue and PR templates * Updated CONTRIBUTING information
1 parent f300e9d commit 2416de7

File tree

3 files changed

+159
-46
lines changed

3 files changed

+159
-46
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
1-
Please include the following information in your ticket.
1+
Please [read these guidelines](http://ibm.biz/cdt-issue-guide) before opening an issue.
22

3-
- java-cloudant-cache version(s) that are affected by this issue.
4-
- Java version (including vendor and platform).
5-
- If you're using the optional okhttp dependency.
6-
- A small code sample that demonstrates the issue.
3+
<!-- Issues will be CLOSED IMMEDIATELY if the following template is not completed. -->
4+
5+
## Bug Description
6+
7+
### 1. Steps to reproduce and the simplest code sample possible to demonstrate the issue
8+
<!--
9+
Outline the steps you take to make the problem happen.
10+
Provide the simplest code sample you can, in context, that reproduces the issue.
11+
-->
12+
13+
### 2. What you expected to happen
14+
15+
### 3. What actually happened
16+
17+
## Environment details
18+
<!--
19+
- Version(s) that are affected by this issue.
20+
> 2.0.2
21+
- Java version including vendor and platform
22+
> 1.8.0_151 OpenJDK macOS
23+
- Using the optional okhttp dependency.
24+
> Yes|No
25+
-->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 91 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,102 @@
1+
<!--
12
Thanks for your hard work, please ensure all items are complete before opening.
3+
-->
4+
## Checklist
25

3-
- [ ] Tick to sign-off your agreement to the [Developer Certificate of Origin (DCO) 1.1](https://github.com/cloudant/java-cloudant-cache/blob/master/DCO1.1.txt)
4-
- [ ] You have added tests for any code changes
5-
- [ ] You have updated the [CHANGES.md](https://github.com/cloudant/java-cloudant-cache/blob/master/CHANGES.md)
6-
- [ ] You have completed the PR template below:
6+
- [ ] Tick to sign-off your agreement to the [Developer Certificate of Origin (DCO) 1.1](../blob/master/DCO1.1.txt)
7+
- [ ] Added tests for code changes _or_ test/build only changes
8+
- [ ] Updated the change log file (`CHANGES.md`|`CHANGELOG.md`) _or_ test/build only changes
9+
- [ ] Completed the PR template below:
710

8-
## What
11+
## Description
12+
<!--
13+
Provide a short description; saving the detail for the `Approach` section
914
10-
What was changed
15+
Also EITHER:
16+
Link to issue this PR is resolving, use the Fixes #nnn form so that the
17+
issue closes automatically when the PR merges e.g.:
1118
12-
## How
19+
Fixes #23
1320
14-
How the change was implemented and reasoning behind it
21+
OR
22+
23+
For PRs without an associated issue and/or test/build issues
24+
25+
### 1. Steps to reproduce and the simplest code sample possible to demonstrate the issue
26+
### 2. What you expected to happen
27+
### 3. What actually happened
28+
-->
29+
30+
## Approach
31+
32+
<!--
33+
Be brief: which component(s) of the code base does the fix focus on.
34+
35+
A place to note whether the part of the code base that is being worked is
36+
particularly sensitive.
37+
-->
38+
39+
## Schema & API Changes
40+
41+
<!--
42+
EITHER:
43+
44+
- "No change"
45+
46+
OR
47+
48+
For public API (as opposed to internal) changes
49+
50+
- "Fixing bug in API, will change x in such-and-such way"
51+
-->
52+
53+
## Security and Privacy
54+
55+
<!--
56+
EITHER:
57+
58+
- "No change"
59+
60+
OR
61+
62+
"Making changes in e.g. auth|https|encryption|io
63+
need to be careful about..."
64+
65+
-->
1566

1667
## Testing
1768

18-
How to test your changes work, not required for documentation changes.
69+
<!--
70+
EITHER:
71+
72+
- Added new tests:
73+
- test x
74+
- test y
75+
- test z
76+
77+
OR
78+
79+
- Modified existing tests because ...
80+
81+
OR
82+
83+
- N/A build or packaging only changes
84+
85+
OR
86+
87+
In exceptional circumstances there may be a good reason we can't add automated
88+
tests, for example if a specific device is required to reproduce a problem.
89+
90+
- No new tests because...
91+
-->
92+
93+
## Monitoring and Logging
94+
<!--
95+
EITHER:
96+
97+
- "No change"
1998
20-
## Issues
99+
OR
21100
22-
Links to the github issue(s) (if present) that this pull request is resolving.
101+
- "Added new log line X..."
102+
-->

‎CONTRIBUTING.md‎

Lines changed: 44 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
1-
Contributing
2-
=======
1+
# Contributing
32

4-
The java-cloudant-cache project is written in Java and uses gradle as its build tool and the maven central
5-
repository for dependencies.
3+
## Issues
4+
5+
Please [read these guidelines](http://ibm.biz/cdt-issue-guide) before opening an issue.
6+
If you still need to open an issue then we ask that you complete the template as
7+
fully as possible.
8+
9+
## Pull requests
10+
11+
We welcome pull requests, but ask contributors to keep in mind the following:
12+
13+
* Only PRs with the template completed will be accepted
14+
* We will not accept PRs for user specific functionality
615

7-
## Developer Certificate of Origin
16+
### Developer Certificate of Origin
817

918
In order for us to accept pull-requests, the contributor must sign-off a
1019
[Developer Certificate of Origin (DCO)](DCO1.1.txt). This clarifies the
@@ -17,28 +26,12 @@ Please read the agreement and acknowledge it by ticking the appropriate box in t
1726

1827
- [x] Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1
1928

20-
## Requirements
21-
22-
- gradle
23-
- Java 1.8
24-
25-
## Installing requirements
29+
## General information
2630

27-
### Java
28-
29-
Follow the instructions for your platform.
30-
31-
### Gradle
32-
33-
The project uses the gradle wrapper to download specified version of gradle.
34-
The gradle wrapper is run by using the following command:
35-
36-
```bash
37-
$ ./gradlew
38-
```
39-
Note: on windows the command to run is gradlew.bat rather than gradlew
31+
The java-cloudant-cache project is written in Java and uses gradle as its build tool and the maven central
32+
repository for dependencies.
4033

41-
## Coding guidelines
34+
### Coding guidelines
4235

4336
The project uses the [Google Java Style](https://google-styleguide.googlecode.com/svn/trunk/javaguide.html)
4437
with the following changes:
@@ -55,7 +48,7 @@ with the following changes:
5548
IDEA defaults to 8, which is okay too.
5649
```
5750

58-
### Code Style
51+
#### Code Style
5952

6053
An IDEA code style matching these guidelines is included in the project,
6154
in the `.idea` folder.
@@ -67,22 +60,43 @@ If you already have the project, to enable the code style follow these steps:
6760

6861
IDEA will then use the style when reformatting, refactoring and so on.
6962

70-
## Building the library
63+
## Requirements
64+
65+
- gradle
66+
- Java 1.8
67+
68+
### Installing requirements
69+
70+
#### Java
71+
72+
Follow the instructions for your platform.
73+
74+
#### Gradle
75+
76+
The project uses the gradle wrapper to download specified version of gradle.
77+
The gradle wrapper is run by using the following command:
78+
79+
```bash
80+
$ ./gradlew
81+
```
82+
Note: on windows the command to run is gradlew.bat rather than gradlew
83+
84+
## Building
7185

7286
The project should build in a cloned repository with:
7387

7488
```bash
7589
$ ./gradlew assemble
7690
```
7791

78-
## Running the tests
92+
## Testing
7993

8094
The tests run as part of Travis CI when branches are pushed to the github repository.
8195

8296
If you want to run the tests locally then note that some tests require additional services:
8397
* `DatabaseCacheTests` need an Apache CouchDB instance or Cloudant instance and if it
84-
is not at http://localhost:5789 you should set the system property `test.couch.url` with the correct
85-
url e.g. (http://your.example:1234).
98+
is not at `http://localhost:5789` you should set the system property `test.couch.url` with the correct
99+
url e.g. (`http://your.example:1234`).
86100
* `RedisCacheTests` require a running Redis instance on the default localhost:6379
87101

88102
Run the tests using:

0 commit comments

Comments
 (0)