From 2ee644019293c2c35d42207dc49de528cb71f666 Mon Sep 17 00:00:00 2001 From: Aleksandras Kostarevas Date: Sat, 27 Jul 2024 21:28:49 +0300 Subject: [PATCH] Add GitHub issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 47 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++++ .github/ISSUE_TEMPLATE/feature_request.yml | 55 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/keyboard_layout.yml | 53 +++++++++++++++++++++ 4 files changed, 166 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/keyboard_layout.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..f3df0c762 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,47 @@ +name: Bug Report +description: Let us know about an unexpected error, a crash, or an incorrect behavior. +labels: ["bug", "new"] +body: + - type: markdown + attributes: + value: | + # Thank you for taking the time to fill out this bug report. + + The [android-keyboard](https://github.com/futo-org/android-keyboard) issue tracker is reserved for issues relating to the FUTO Keyboard Android Application + + For general usage questions, please see the [FUTO Keyboard Zulip Channel](https://chat.futo.org/#narrow/stream/53-Keyboard) or the [FUTO Keyboard Discord](https://keyboard.futo.org/discord) + + Please open bug reports one at a time. If you have 3 separate feature requests/bugs, do not combine them into one issue, this makes it really difficult to track and understand them. + + ## Filing a bug report + + To fix your issues faster, we need clear reproduction cases - ideally allowing us to make it happen locally. + * Please include all needed context. For example, Device, OS, Application, any relevant settings. + * If you've found a particular series of interactions can introduce buggy behavior, please label those steps 1-n with markdown + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: What did you expect to happen? + placeholder: Tell us what you see! + validations: + required: true + + - type: input + id: keyboard-version + attributes: + label: Keyboard Version + description: Open the FUTO Keyboard settings and look for the version name at the bottom, or in the Help & Feedback menu. Please make sure you're up-to-date before filing a bug report. Reports from outdated versions may be closed. + placeholder: "0.1.22" + validations: + required: true + + - type: textarea + id: editor-info + attributes: + label: Text field info + description: If this issue happens in some text fields and not others, it may be related to that specific app's text field. To help diagnose these issues, please enable the Debug Info action and attach a screenshot of the Editor Info section, or describe the app and the text field. + placeholder: (e.g. Search bar in DuckDuckGo) + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..a7b606df2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Want to pay for FUTO Keyboard? + url: https://pay.futo.org/api/PaymentPortal + about: Pay for FUTO Keyboard at pay.futo.org + - name: Zulip Chat + url: https://chat.futo.org/#narrow/stream/53-Keyboard + about: FUTO Keyboard community chat + - name: Discord Chat (if you don't like Zulip) + url: https://keyboard.futo.org/discord + about: FUTO Keyboard community chat \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..db1b5affc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,55 @@ +name: Feature Request +description: Suggest a new feature or other enhancement. +labels: ["enhancement", "new"] +body: + - type: markdown + attributes: + value: | + # Thank you for opening a feature request. + + The [android-keyboard](https://github.com/futo-org/android-keyboard) issue tracker is reserved for issues relating to the FUTO Keyboard Android Application + + For discussion related to enhancements, please see the [FUTO Keyboard Zulip Channel](https://chat.futo.org/#narrow/stream/53-Keyboard) or the [FUTO Keyboard Discord](https://keyboard.futo.org/discord) + + Please open feature requests one at a time. If you have 3 separate feature requests/bugs, do not combine them into one issue, this makes it really difficult to track and understand them. + + Before opening a feature request, please make sure you're using the latest version of the keyboard, it may have already been added. + - type: textarea + id: keyboard-use-case + attributes: + label: Use Cases + description: | + In order to properly evaluate a feature request, it is necessary to understand the use cases for it. Please describe the usability problem you are having. Please keep this section focused on the problem and not on the suggested solution. + placeholder: "" + validations: + required: true + + - type: textarea + id: keyboard-proposal + attributes: + label: Proposal + description: | + If you have an idea for a way to address the problem, please describe it below. + + In this section, it's helpful to include specific examples of how what you are suggesting might look in the application. If this is a standard feature in some other keyboards, you may want to mention it here and attach screenshots if applicable. + placeholder: "" + validations: + required: false + + - type: textarea + id: keyboard-references + attributes: + label: References + description: | + Are there any other GitHub issues, whether open or closed, that are related to the problem you've described above or to the suggested solution? If so, please create a list below that mentions each of them. For example: + ``` + - #10 + ``` + placeholder: "" + validations: + required: false + + - type: markdown + attributes: + value: | + **Note:** If the submit button is disabled and you have filled out all required fields, please check that you did not forget a **Title** for the issue. diff --git a/.github/ISSUE_TEMPLATE/keyboard_layout.yml b/.github/ISSUE_TEMPLATE/keyboard_layout.yml new file mode 100644 index 000000000..c06fb9ccc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/keyboard_layout.yml @@ -0,0 +1,53 @@ +name: Keyboard Layout +description: Request a new keyboard layout, language, or a change to an existing layout +labels: ["layout", "new"] +body: + - type: markdown + attributes: + value: | + # Thank you for opening a keyboard layout request. + + The [android-keyboard](https://github.com/futo-org/android-keyboard) issue tracker is reserved for issues relating to the FUTO Keyboard Android Application + + For discussion related to enhancements, please see the [FUTO Keyboard Zulip Channel](https://chat.futo.org/#narrow/stream/53-Keyboard) or the [FUTO Keyboard Discord](https://keyboard.futo.org/discord) + + Please open requests one at a time. If you have 3 separate feature requests/bugs, do not combine them into one issue, this makes it really difficult to track and understand them. + + - type: input + id: language + attributes: + label: Language + description: Which language is this layout for? + placeholder: "Swedish" + validations: + required: false + + - type: textarea + id: description + attributes: + label: Description + description: Describe the layout to be added/changed, you can include the layout itself in a codeblock and any special behavior such as long-press keys. If this is a standard layout in other mobile keyboards, please mention it here and attach a screenshot of the layout. + placeholder: | + ``` + q w e r t y u i o p + a s d f g h j k l + z x c v b n m + ``` + + long-press q should have letter č + validations: + required: true + + - type: textarea + id: complexity + attributes: + label: Complexity + description: Does this language or layout require any complex input logic (e.g. Pinyin input method, Hangul character combiner) that does not already exist in the existing keyboard layouts? If so, please link to any open-source libraries or code that you're aware of for input in this language that may serve as a useful reference. + placeholder: "" + validations: + required: false + + - type: markdown + attributes: + value: | + **Note:** If the submit button is disabled and you have filled out all required fields, please check that you did not forget a **Title** for the issue. \ No newline at end of file