update readme / templates / guidelines

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,13 +12,14 @@ tl;dr:
 
 <!--
 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 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**
 
 **To Reproduce**
 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**
 If it's not obvious (e.g. not crash), describe how you think the app should behave.

.github/PULL_REQUEST_TEMPLATE.md

@@ -8,9 +8,11 @@ tl;dr (you should still read the full list though):
 * make it a draft if you still want to work on it
 * no translations or dictionaries
 
+A good description and small scope ("single thing") massively help with reviewing. Don't be surprised when your PR gets closes if you clearly / repeatedly violate these parts of the guidelines.
+
 Further
 * 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 keyboard layout, make sure you also 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 to see which parts have changed since the previous state.
+* Please avoid force-pushing when doing changes unless you have a good reason. This way it's not possible to see which parts have changed since the previous state.
 
 <!-- (please remove the text above before submitting the PR) -->

CONTRIBUTING.md

@@ -2,14 +2,15 @@
 
 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](git@github.com: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!
 
+If you have difficulties implementing some functionality, you're welcome to ask for help. No one will write the code for you, but often other contributors can give you very useful hints.
+
 # 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, so we can discuss how changes are best implemented.
-  If there is no accepted 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.
+  If there is no accepted issue related to your intended contribution, it's a good idea to open a new one (and of course getting one of "PR" or "contributor needed" labels) 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 or semi-related 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. Therefore the changes should be as described, not more and not less.
@@ -19,10 +20,10 @@ HeliBoard is a complex application, when contributing, you must take a step back
   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 leave dependency upgrades to the maintainers, unless it's an actual security issue)
+A good description and small scope ("single thing") massively help with reviewing. Don't be surprised when your PR gets closes if you clearly / repeatedly violate these parts of the guidelines.
-In addition to previous elements, HeliBoard must stick to [F-Droid inclusion guidelines](https://f-droid.org/docs/Inclusion_Policy/).
+If possible try to keep your changes contained, i.e. in few places as opposed to sprinkling them over many parts of the code. This helps with both review and maintainability of the app.
 
-If you have difficulties implementing some functionality, you're welcome to ask for help. No one will write the code for you, but often other contributors can give you very useful hints.
+Please leave dependency upgrades to the maintainers, unless it's an actual security issue.
 
 # Adding Layouts
 

README.md

@@ -46,7 +46,7 @@ Does not use internet permission, and thus is 100% offline.
   <li>Backup and restore your settings and learned word / history data</li>
 </ul>
 
-For FAQ and more information about the app and features, please visit the [wiki](https://github.com/Helium314/HeliBoard/wiki)
+For [FAQ](https://github.com/Helium314/HeliBoard/wiki/FAQ) and more information about the app and features, please visit the [wiki](https://github.com/Helium314/HeliBoard/wiki)
 
 # Contributing ❤
 
@@ -97,19 +97,17 @@ __Planned features and improvements:__
 * Less complicated addition of new keyboard languages (e.g. #519)
 * Additional and customizable key swipe functionality
   * Some functionality will not be possible when using glide typing
-* Ability to enter all emojis independent of Android version (optional, #297)
 * Add and enable emoji dictionaries by default (if available for language)
 * Clearer / more intuitive arrangement of settings
   * Maybe hide some less used settings by default (similar to color customization)
 * Make use of the `.com` key in URL fields (currently only available for tablets)
   * With language-dependent TLDs
-* Internal cleanup (a lot of over-complicated and convoluted code)
 * [Bug fixes](https://github.com/Helium314/HeliBoard/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
 
 __What will _not_ be added:__
 * Material 3 (not worth adding 1.5 MB to app size)
 * Dictionaries for more languages (you can still download them)
-* Anything that requires additional permissions, unless there is a very good reason
+* Anything that requires additional permissions, unless there is a _very_ good reason
 
 # License
 
@@ -120,7 +118,6 @@ HeliBoard (as a fork of OpenBoard) is licensed under GNU General Public License
 See repo's [LICENSE](/LICENSE) file.
 
 Since the app is based on Apache 2.0 licensed AOSP Keyboard, an [Apache 2.0](LICENSE-Apache-2.0) license file is provided.
-
 The icon is licensed under [Creative Commons BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/). A [license file](LICENSE-CC-BY-SA-4.0) is also included.
 
 # Credits