Modernization and Feature Implementation

.editorconfig

@@ -0,0 +1,13 @@
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 140
+tab_width = 4
+trim_trailing_whitespace = true
+
+[{*.markdown,*.md}]
+trim_trailing_whitespace = false
+indent_size = 2

.github/DISCUSSION_TEMPLATE/custom-colors.yml

@@ -0,0 +1,18 @@
+body:
+- type: input
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      placeholder: |
+        "You can add some description and screenshots here if you want."
+    validations:
+      required: false
+  - type: textarea
+    id: colors
+    attributes:
+      label: Colors
+      placeholder: |
+        "Please paste the colors (obtained via the _copy_ button) here, and surround the text with ``` to make sure it's displayed in a way that can be copied easily."
+    validations:
+      required: true

.github/DISCUSSION_TEMPLATE/custom-layout.yml

@@ -0,0 +1,18 @@
+body:
+- type: input
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      placeholder: |
+        "You can add some description and screenshots here if you want."
+    validations:
+      required: false
+  - type: textarea
+    id: layout
+    attributes:
+      label: Layout
+      placeholder: |
+        "Please paste the layout here, and surround it with ``` to make sure it's displayed in a way that can be copied easily."
+    validations:
+      required: true

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+
+liberapay: Helium314

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,31 +1,36 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
 labels: bug
-assignees: ''
-
 ---
 
+Please see the appropriate readme section for issue reporting guidelines: https://github.com/Helium314/HeliBoard?tab=readme-ov-file#reporting-issues
+tl;dr:
+* search for duplicates, also in closed issues
+* a single issue per topic
+* reduce screenshot size
+
+<!--
+issue template below, please remove above text before submitting (and the template too if you think it's a good idea)
+Please choose a meaningful title for your issue, and consider that if you want help you should provide enough information that people can actually help
+-->
+
 **Describe the bug**
-A clear and concise description of what the bug is.
 
 **To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+If possible, provide all the necessary steps to reproduce your problem, including the involved apps or settings if relevant.
+In case you cannot reproduce the bug, say so and provide information about when the bug may occur for you. Settings and the app you're writing in are usually important, please don't omit them.
 
 **Expected behavior**
-A clear and concise description of what you expected to happen.
+If it's not obvious (e.g. not crash), describe how you think the app should behave.
 
 **Screenshots**
-If applicable, add screenshots to help explain your problem.
+ONLY add screenshots when they add real value.
+If you add screenshots, reduce the size or use thumbnails to keep the issue nicely readable.
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. Samsung Galaxy S9]
- - OS: [e.g. Android 10]
+**App version**
+Please provide the explicit version (not just "latest"), or if you build the app yourself specify the latest commit.
 
-**Additional context**
-Add any other context about the problem here.
+**Device:**
+ - Model: [e.g. Samsung Galaxy S9]
+ - OS: [e.g. Android 10] (please also mention whether you are using the manufacturer's OS or a custom ROM)

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Dictionary request
+    url: https://codeberg.org/Helium314/aosp-dictionaries
+    about: Requests for dictionaries (used for suggestions / autocompletion) will be handled in the linked dictionary repository. You can check whether a dictionary for the language you want already exists there.
+  - name: Discussion
+    url: https://github.com/Helium314/HeliBoard/discussions
+    about: For discussions and feedback about this app, asking questions or talking about ideas which are not yet actionable (i.e. not suitable for an issue).
+  - name: Question
+    url: https://github.com/Helium314/HeliBoard/discussions/new?category=q-a
+    about: For questions please use the discussions section. You may also want to search your question in the FAQ (see readme).

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,32 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
 labels: enhancement
-assignees: ''
-
 ---
 
+Please see the appropriate readme section for issue reporting guidelines: https://github.com/Helium314/HeliBoard?tab=readme-ov-file#reporting-issues
+tl;dr:
+* search for duplicates, also in closed issues
+* check FAQ / hidden features
+* a single issue per topic
+* ONLY add screenshots when necessary, and reduce their size
+
+<!--
+issue template below, please remove above text before submitting (and the template too if you think it's a good idea)
+Please choose a meaningful title for your issue
+-->
+
+<!-- Please check FAQ and hidden features whether what you want is already implemented -->
+
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
 **Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+Please provide a description of what you would like to have. The clearer it is described, the better it can be implemented the way you want it.
+
+**Use case**
+Provide a clear and concise description of *your use case* and what you thus think is missing, and why.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+**Describe alternatives you've considered (if any)**
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+**App version**
+Please provide the explicit version, you're using.

.github/ISSUE_TEMPLATE/other.md

@@ -0,0 +1,12 @@
+---
+name: Other
+about: Anything that does not fit into the other categories. Please don't use this for questions, discussions, or anything that fits into one of the other issue categories.
+---
+
+Please see the appropriate readme section for issue reporting guidelines: https://github.com/Helium314/HeliBoard?tab=readme-ov-file#reporting-issues
+tl;dr:
+* search for duplicates, also in closed issues
+* a single issue per topic
+* ONLY add screenshots when necessary, and reduce their size
+
+<!-- please remove above text before submitting, and choose a meaningful title for your issue -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+Please make sure you are at least reasonably close to the contribution guidelines: https://github.com/Helium314/HeliBoard/blob/main/CONTRIBUTING.md#guidelines
+Due to maintainer availability, your PR may take quite some time to be addressed
+<!-- (please remove the text above before submitting the PR) -->

.github/workflows/build-debug-apk.yml

@@ -0,0 +1,39 @@
+name: Build debug APK
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - uses: gradle/actions/setup-gradle@v3
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew assembleDebug
+
+      - name: Upload APK
+        uses: actions/upload-artifact@v4
+        with:
+          name: HeliBoard-debug
+          path: app/build/outputs/apk/debug/*-debug*.apk
+
+      - name: Archive reports for failed job
+        uses: actions/upload-artifact@v4
+        with:
+          name: reports
+          path: '*/build/reports'
+        if: ${{ failure() }}

.github/workflows/build-test-auto.yml

@@ -0,0 +1,43 @@
+name: Test build
+# builds only for a single abi and does not produce an APK
+
+on:
+# disabled on push: when I push to non-main, I do a PR anyway
+#  push:
+    # don't run on main. I noticed I often don't push commits to avoid unnecessary workflow runs
+#    branches-ignore: [ main ]
+#    paths:
+#      - 'app/**'
+  pull_request:
+    paths:
+      - 'app/src/main/java**'
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - uses: gradle/actions/setup-gradle@v3
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew testRunTestsUnitTest
+
+      - name: Archive reports for failed job
+        uses: actions/upload-artifact@v4
+        with:
+          name: reports
+          path: '*/build/reports'
+        if: ${{ failure() }}

.gitignore

@@ -1,11 +1,14 @@
 *.iml
 .idea
 .gradle
+.kotlin
 local.properties
 .DS_Store
 Gemfile
 build
 app/build
 app/release
 app/.cxx
+app/.attach_*
 fastlane/Appfile
+tools/*.txt