Skip to content

Commit f3909a0

Browse files
Bruce Irschickbirschick-bq
Bruce Irschick
andauthored
[AD-433] Add in Contribution Guide how to ask questions using GitHub Issues (#175)
### Summary [AD-433] Add in Contribution Guide how to ask questions using GitHub Issues ### Description Added: - bug and feature templates. - links to the open and closed issues page. - removed Mitchell from the PR template. ### Related Issue https:/bitquill.atlassian.net/browse/AD-433 * [AD-433] Add in Contribution Guide how to ask questions using GitHub Issues https:/bitquill.atlassian.net/browse/AD-433 * Commit Code Coverage Badge Co-authored-by: birschick-bq <[email protected]>
1 parent 8aac0b3 commit f3909a0

File tree

4 files changed

+61
-2
lines changed

4 files changed

+61
-2
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Report an issue for the AWS DocumentDB JDBC Driver project.
4+
title: "[BUG]"
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
##Environment
11+
- DocumentDB JDBC driver version:
12+
- DocumentDB server version:
13+
- OS: [e.g. MacOS Big Sur 11.5.1, Windows 10 64-bit]
14+
- BI Tool or client name:
15+
- BI Tool or client version:
16+
- Java version (if known):
17+
18+
---
19+
20+
##Problem Description
21+
1. Steps to reproduce:
22+
2. Expected behaviour:
23+
3. Actual behaviour:
24+
4. Error message/stack trace:
25+
5. Any other details that can be helpful:
26+
27+
---
28+
29+
##Screenshots
30+
- If applicable, add screenshots to help explain your problem.
31+
32+
---
33+
34+
##JDBC log
35+
- Add related JDBC log entries here.
+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for the DocumentDB JDBC Driver project.
4+
title: '[FEATURE]'
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
##Is your feature request related to a problem? Please describe.
11+
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
14+
##Describe the solution you'd like
15+
16+
A clear and concise description of what you want to happen.
17+
18+
##Describe alternatives you've considered
19+
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
##Additional context
23+
24+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,3 @@
1515
@andiem-bq
1616
@alexey-temnikov
1717
@birschick-bq
18-
@mitchell-elholm

CONTRIBUTING.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ information to effectively respond to your bug report or contribution.
1111

1212
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1313

14-
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
14+
When filing an issue, please check [existing open](https://github.com/aws/amazon-documentdb-jdbc-driver/issues),
15+
or [recently closed](https://github.com/aws/amazon-documentdb-jdbc-driver/issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already
1516
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
1617

1718
* A reproducible test case or series of steps

0 commit comments

Comments
 (0)