Merge branch 'main' into lang_swipe_sensitivity

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,40 +4,29 @@ about: Create a report to help us improve
 labels: bug
 ---
 
-<!--
-tl;dr
-* search for duplicates also in closed issues
-* one issue per topic
+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
 
-Please search open and closed issues to avoid duplicates. Maybe what you want has already been discussed or is mentioned in the readme.
-If you want to report more issues / bugs, open multiple issues (one for each).
-If you're interested, you can read the following useful text about effective bug reporting (a bit longer read): https://www.chiark.greenend.org.uk/~sgtatham/bugs.html -->
+<!-- issue template below, please remove above text before submitting (and the template too if you think it's a good idea) -->
 
 **Describe the bug**
-<!-- A clear and concise description of what the bug is. -->
 
 **To Reproduce**
-<!-- If possible, provide clear steps to reproduce the behavior, e.g.:
-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.
 
 **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**
-<!-- ONLY if applicable and helpful, add screenshots to help explain your problem.
-If you add screenshots, reduce the size or use thumbnails to keep the issue nicely readable. -->
+ONLY add screenshots if applicable and helpful.
+If you add screenshots, reduce the size or use thumbnails to keep the issue nicely readable.
 
 **App version**
-<!-- Which version of this app is affected? If you build the app yourself, please specify the latest commit included in the build -->
+Please provide the explicit version, or if you build the app yourself specify the latest commit.
 
 **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)
-
-**Additional context**
-<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,30 +4,20 @@ about: Suggest an idea for this project
 labels: enhancement
 ---
 
-<!--
-tl;dr
-* search for duplicates also in closed issues
-* one issue per topic
+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
 
-Please search open and closed issues to avoid duplicates. Maybe what you want has already been discussed or is mentioned in the readme.
-If you have more than one feature request, open multiple issues (one for each) unless the requests are closely related.
-Note that given the number of feature requests and available developer time, it may take a long time until the feature request gets attention.
-When a "PR" or "contributor needed" label is added, the feature request is accepted, and interested contributors are welcome to work on this (please comment when you're working on an issue).
--->
+<!-- issue template below, please remove above text before submitting (and the template too if you think it's a good idea) -->
 
 **Is your feature request related to a problem? Please describe.**
-<!-- A clear and concise description of what the problem is. -->
 
 **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. -->
+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 (if you can think of any). -->
-
-**Additional context**
-<!-- Add any other context or screenshots about the feature request here if suitable and useful.
-If you add screenshots, reduce the size or use thumbnails to keep the issue nicely readable. -->
+**Describe alternatives you've considered (if any)**

.github/ISSUE_TEMPLATE/other.md

@@ -1,16 +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.
+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.
 ---
 
-<!--
-tl;dr
-* search for duplicates also in closed issues
-* one issue per topic
+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
 
-Please search open and closed issues to avoid duplicates. Maybe what you want has already been discussed or is mentioned in the readme.
-Open one issue per topic / request, and do not use this category for bug reports or feature requests.
-
-If you add screenshots, reduce the size or use thumbnails to keep the issue nicely readable.
--->
+<!-- please remove above text before submitting -->

.github/ISSUE_TEMPLATE/spell_checker.md

@@ -4,16 +4,13 @@ about: Issue related to spell checker (this is the component that underlines mis
 labels: "spell checker"
 ---
 
-<!--
-tl;dr
-* search for duplicates also in closed issues
-* one issue per topic
+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
 
 Make sure you actually enabled HeliBoard spell checker. Usually it can be found in System Settings -> System -> Languages -> Advanced -> Spell Checker, but this may depend on Android version.
 Note that the menu when tapping a word underlined in red is coming form the Android system and is not under control of HeliBoard.
 
-Please search open and closed issues to avoid duplicates. Maybe what you want has already been discussed or is mentioned in the readme.
-Open one issue per topic / request, and do not use this category for bug reports or feature requests.
-If you add screenshots, reduce the size or use thumbnails to keep the issue nicely readable.
--->
+<!-- please remove above text before submitting -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +1,16 @@
-<!--
-See the contributing section in the readme for more detailed guideline: https://github.com/Helium314/HeliBoard?tab=readme-ov-file#guidelines
-Most importantly:
-* The PR should focus on a single contribution.
-* Describe briefly what your pull request proposes to fix or improve.
-* If it's not completely obvious, describe what the PR does to achieve the desired result.
+See the contributing readme for more detailed guideline: https://github.com/Helium314/HeliBoard/blob/main/CONTRIBUTING.md
+tl;dr (you should still read the full list though):
+* make sure it's wanted
+* a single thing only
+* describe it properly
+* re-use existing mechanisms / code
+* low performance impact
+* make it a draft if you still want to work on it
+* don't do translation PRs
 
 Further
-* If you use someone else's code, please mention or better link to the source.
 * When the PR contains "fixes" <issue number>, the related issue will be linked and automatically closed if the PR is merged (also works for other words like "fix", "resolve", "resolves", "closes", ...)
-* If you add a layout, make sure you have read https://github.com/Helium314/HeliBoard/blob/main/layouts.md#adding-new-layouts--languages
--->
+* If you add a keyboard layout, make sure you have read https://github.com/Helium314/HeliBoard/blob/main/layouts.md#adding-new-layouts--languages
+* Please avoid force-pushing when doing changes. This way it's not possible which parts have changed since the previous state.
+
+(please remove the template text before submitting the PR)

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

@@ -2,11 +2,12 @@ name: Test build
 # builds only for a single abi and does not produce an APK
 
 on:
-  push:
+# 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/**'
+#    branches-ignore: [ main ]
+#    paths:
+#      - 'app/**'
   pull_request:
     paths:
       - 'app/**'
@@ -32,7 +33,7 @@ jobs:
         run: chmod +x gradlew
 
       - name: Build with Gradle
-        run: ./gradlew assembleDebug
+        run: ./gradlew -Pandroid.injected.build.abi=arm64-v8a assembleDebug
 
       - name: Archive reports for failed job
         uses: actions/upload-artifact@v4

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Getting Started
+
+HeliBoard project is based on Gradle and Android Gradle Plugin. To get started, you can install [Android Studio](https://developer.android.com/studio), and import project 'from Version Control / Git / Github' by providing this git repository [URL](https://github.com/Helium314/HeliBoard) (or git SSH [URL]([email protected]:Helium314/heliboard.git)).
+Of course you can also use any other compatible IDE, or work with text editor and command line.
+
+Once everything is up correctly, you're ready to go!
+
+# Guidelines
+
+HeliBoard is a complex application, when contributing, you must take a step back and make sure your contribution:
+- **Is actually wanted**. Best check related open issues before you start working on a PR. Issues with "PR" and "contributor needed" labels are accepted, but still it would be good if you announced that you are working on it.
+  If there is no issue related to your intended contribution, it's a good idea to open a new one to avoid disappointment of the contribution not being accepted. For small changes or fixing obvious bugs this step is not necessary.
+- **Is only about a single thing**. Mixing unrelated contributions into a single PR is hard to review and can get messy.
+- **Is finished or a draft**. When you keep changing the PR without reviewer's feedback, any attempt to review it is doomed and a waste of time. Better mark it as a draft in this case.
+- **Has a proper description**. What your contribution does is usually less obvious to reviewers than for yourself. A good description helps _a lot_ for understanding what is going on, and for separating wanted from unintended changes in behavior.
+- **Uses already in-place mechanism and take advantage of them**. In other terms, does not reinvent the wheel or uses shortcuts that could alter the consistency of the existing code. The contribution should only add as little complexity as necessary, the code is overly complicated already 😶.
+- **Has a low footprint**. Some parts of the code are executed very frequently, and the keyboard should stay responsive even on older devices.
+- **Does not bring any non-free code or proprietary binary blobs**. This also applies to code/binaries with unknown licenses. Make sure you do not introduce any closed-source library from Google.
+  If your contribution contains code that is not your own, provide a link to the source.
+- **Complies with the user privacy principle HeliBoard follows**.
+
+(and please leave dependency upgrades to the maintainers, unless it's an actual security issue)
+In addition to previous elements, HeliBoard must stick to [F-Droid inclusion guidelines](https://f-droid.org/docs/Inclusion_Policy/).
+
+# Adding Layouts
+
+See [layouts.md](layouts.md#adding-new-layouts--languages) for how to add new layouts to the app.
+
+# Update Emojis
+
+See make-emoji-keys tool [README](tools/make-emoji-keys/README.md).
+
+# Update List of Existing Dictionaries
+
+See make-dict-list tool [README](tools/make-dict-list/README.md).
+
+# Translations
+Translations can be added using [Weblate](https://translate.codeberg.org/projects/heliboard/). You will need an account to update translations and add languages. Add the language you want to translate to in Languages -> Manage translated languages in the top menu bar.
+Updating translations in a PR will not be accepted, as it may cause conflicts with Weblate translations.