diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000000..ce00ee3b03 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index b81b119fa6..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Bug report -about: You think you have found a bug! - ---- - -#### Goal - - -#### Actual Results - - -#### Steps & Code to Reproduce - - - - -#### Version of Realm and tooling - -Realm version(s): ? - -Realm Sync feature enabled: Yes/No - -Android Studio version: ? - -Android Build Tools version: ? - -Gradle version: ? - -Which Android version and device(s): ? diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..b93b98b8cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000000..039db59f91 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index e3480bcf09..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Feature request -about: Suggest an enhacement or new feature for this project - ---- - -#### Describe your problem or use case - - - -#### Describe the solution you'd like - - - -#### Additional context - diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index a7d25e37fc..0000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Question? -about: Got a question about how to use Realm? - ---- - -We only use Github issues for bugs or new feature ideas. -Please use one of the following options instead: - -* [Stack Overflow](http://stackoverflow.com/questions/ask?tags=realm) -is good to get specific help about how to do use Realm. - -* [Realm Forums](https://forum.realm.io/) is great for general Realm questions -that are now allowed on StackOverflow like best practices etc. - -* [Realm Support](https://support.realm.io) can be used if you are a paying Realm Cloud user -or have a support contract with Realm. If you would like a support contract -you can contact [Sales](sales@realm.io).