Skip to content

Commit

Permalink
GitHub | Update Issue and Pull Request templates. (#906)
Browse files Browse the repository at this point in the history
  • Loading branch information
cheenamalhotra authored Dec 17, 2018
1 parent 9276e40 commit 5afcae3
Show file tree
Hide file tree
Showing 8 changed files with 146 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Bug report
about: Report a bug to help us improve
title: "[BUG]"
labels: bug
assignees: ''

---

## Driver version
<!--- Provide the JDBC driver version (e.g. 7.0.0). -->

## SQL Server version
<!--- Provide the output of executing `SELECT @@VERSION` on your target SQL Server. -->

## Client Operating System
<!--- Provide the Operating System the client application is running on. -->

## JAVA/JVM version
<!--- Provide the JAVA/JVM version (e.g. java version "1.8.0", IBM J9 VM). -->

## Table schema
<!--- Provide the table schema. -->

## Problem description
<!--- Provide full details of the problem. -->
1. Expected behaviour:
2. Actual behaviour:
3. Error message/stack trace:
4. Any other details that can be helpful:

## JDBC trace logs
<!--- Provide the JDBC trace logs. Instructions can be found here: https://docs.microsoft.com/sql/connect/jdbc/tracing-driver-operation?view=sql-server-2017 -->

## Reproduction code
<!--- Provide standalone JAVA code that reproduces the issue, preferably raw JDBC code. -->
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature Request
about: Suggest an idea for this project
title: "[FEATURE REQUEST]"
labels: enhancement
assignees: ''

---

## Is your feature request related to a problem? If so, please give a short summary of the problem and how the feature would resolve it
<!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --->

## Describe the preferred solution
<!--- A clear and concise description of what you want to happen. --->

## Describe alternatives you've considered
<!--- A clear and concise description of any alternative solutions or features you've considered. --->

## Additional context
<!--- Add any other context or screenshots about the feature request here. --->

## Reference Documentations/Specifications
<!--- Provide links to JDBC Specifications or any other related documentation. --->

<!--- Optional --->
## Reference Implementation
<!--- Provide link to any available implementation references --->
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Question
about: Discuss an idea to see if it would be an appropriate Issue.
title: "[QUESTION]"
labels: question
assignees: ''

---

## Question
<!--- What is the question that you have? Please be detailed and give examples. --->

## Relevant Issues and Pull Requests
<!--- If there are relevant issues and pull requests please list and link them here. --->
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Bug Fix
about: Fix for a driver issue
title: "Fix | "

---

## Problem description
<!--- Provide full details of the problem if no corresponding GitHub issue exists. --->

### Fixes existing GitHub issue
<!--- Provide link to GitHub issue above. --->

## Fix Description
<!--- Briefly describe the fix implementation. --->

## New Public APIs
<!--- List any new public APIs added with this Fix. --->

16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Feature
about: Propose a new feature to the driver
title: "Feature | "

---

## Brief Description
<!--- Briefly describe the feature introduced with the PR. --->

<!--- Optional --->
### Fixes existing GitHub issue
<!--- Provide link to GitHub issue above. --->

## New Public APIs
<!--- List any new public APIs added with this Feature. --->
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/improvements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Improvements
about: Improve driver's performance/code quality
title: "Improvement | "

---

## Brief Description
<!--- Briefly describe the changes introduced with the PR. --->
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Other
about: Propose a custom change to the project source code.
title: "Other | "

---

## Brief Description
<!--- Briefly describe the feature introduced with the PR. --->

<!--- Optional --->
### Fixes existing GitHub issue
<!--- Provide link to GitHub issue above. --->

## New Public APIs
<!--- List any new public APIs added with this Feature. --->
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Release
about: Push changes for release preparations
title: "Release | "

---

## Brief Description
<!--- Briefly describe the changes introduced with the PR. --->

0 comments on commit 5afcae3

Please sign in to comment.