Skip to content

Commit

Permalink
Merge pull request #7537 from realm/bmunkholm/issuetemplates
Browse files Browse the repository at this point in the history
Add issue forms
  • Loading branch information
bmunkholm authored Aug 24, 2021
2 parents 6995654 + 936cff3 commit 79723ab
Show file tree
Hide file tree
Showing 6 changed files with 148 additions and 64 deletions.
100 changes: 100 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
name: Bug Report
description: Report a bug
labels: [T-Bug]
body:
- type: markdown
attributes:
value: |
Please provide as much detail as you can so we have a better chance of fixing the bug quickly.
Thanks for your contribution to improve this project!
- type: dropdown
id: frequency
attributes:
label: How frequently does the bug occur?
options:
- Seen once
- Sometimes
- All the time
validations:
required: true
# Description
- type: textarea
id: description
attributes:
label: Description
description: |
Describe what you were expecting and what actually happened.
validations:
required: true
- type: textarea
id: stacktrace
attributes:
label: Stacktrace & log output
description: Please paste any relevant log output or stacktrace if you're getting an exception/crash.
render: shell
# Repro information
- type: dropdown
id: repro
attributes:
label: Can you reproduce the bug?
options:
- Yes, always
- Yes, sometimes
- Not yet
validations:
required: true
- type: textarea
id: code-snippets
attributes:
label: Reproduction Steps
description: |
If you can reproduce the bug, please provide detailed steps for how WE can reproduce it.
Ideally, please provide a self contained test case or link (e.g. github repo) to a sample app that demonstrates the bug.
If that's not possible, please show code samples that highlight or reproduce the issue.
If relevant, include your model definitions.
Should you need to share code confidentially, you can send a link to: realm-help (the @) mongodb.com.
# Version
- type: input
id: version
attributes:
label: Version
description: What version(s) of the SDK has the bug been observed in?
validations:
required: true
- type: dropdown
id: sync
attributes:
label: What SDK flavour are you using?
options:
- Local Database only
- MongoDB Realm (i.e. Sync, auth, functions)
validations:
required: true
- type: dropdown
id: encryption
attributes:
label: Are you using encryption?
options:
- Yes, using encryption
- No, not using encryption
validations:
required: true
# Environment
- type: input
id: platform
attributes:
label: Platform OS and version(s)
description: OS and version(s) are you seeing the issue on?
validations:
required: true
- type: textarea
id: java-build-environment
attributes:
label: "Build environment"
description: Build environment versions
value: |
Android Studio version: ...
Android Build Tools version: ...
Gradle version: ...
validations:
required: false
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: General Questions and Inquiries
url: https://www.mongodb.com/community/forums/tags/c/realm-sdks/58/java
about: Please ask general design/architecture questions in the community forums.
- name: MongoDB Realm (Sync) Production Issues
url: https://support.mongodb.com/
about: Please report urgent production issues to the support portal directly.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Feature Request
description: Request a new feature or enhancement
labels: [T-Enhancement]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest improvements to the SDK!
- type: textarea
id: problem
attributes:
label: Problem
description: A clear and concise description of the problem you are trying to solve.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Solution
description: Describe the solution you envision, including API and usage example if possible.
validations:
required: false
- type: textarea
id: alternative-solution
attributes:
label: Alternatives
description: Describe the alternative solutions or features you have considered
validations:
required: false
- type: dropdown
id: importance
attributes:
label: How important is this improvement for you?
options:
- Dealbreaker
- Would be a major improvement
- I'd like to see it, but have a workaround
- Fairly niche, but nice to have anyway.
validations:
required: false
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

0 comments on commit 79723ab

Please sign in to comment.