luckyimnotanigger/HeliBoard
1
0
Fork 0
mirror of https://github.com/Helium314/HeliBoard.git synced 2025-04-16 04:12:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update templates

Browse source 
maybe there is a way of convincing users to at least understand the 15 word tl;dr
This commit is contained in:
Helium314 2024-04-25 20:35:14 +02:00
parent 9c2cf04d4a
commit 6ff98d3a05
7 changed files with 45 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -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 -->
**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.
**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. -->

26
.github/ISSUE_TEMPLATE/feature_request.md vendored
View file

@ -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 -->
**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)**

16
.github/ISSUE_TEMPLATE/other.md vendored
View file

@ -1,16 +1,10 @@
---
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.
-->

13
.github/ISSUE_TEMPLATE/spell_checker.md vendored
View file

@ -4,16 +4,11 @@ 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.
-->

17
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -1,12 +1,13 @@
<!--
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.
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

10
README.md
View file

@ -101,11 +101,14 @@ Features that may go unnoticed, and further potentially useful information
Whether you encountered a bug, or want to see a new feature in HeliBoard, you can contribute to the project by opening a new issue [here](https://github.com/Helium314/HeliBoard/issues). Your help is always welcome!
Before opening a new issue, be sure to check the following:
- **Does the issue already exist?** Make sure a similar issue has not been reported by browsing [existing issues](https://github.com/Helium314/HeliBoard/issues). Please search open and closed issues.
- **Does the issue already exist?** Make sure a similar issue has not been reported by browsing [existing issues](https://github.com/Helium314/HeliBoard/issues?q=). Please search open and closed issues.
- **Is the issue still relevant?** Make sure your issue is not already fixed in the latest version of HeliBoard.
- **Is it a single topic?** If you want to suggest multiple things, open multiple issues.
- **Did you use the issue template?** It is important to make life of our kind contributors easier by avoiding issues that miss key information to their resolution.
Note that issues that that ignore part of the issue template will likely get treated with very low priority, as often they are needlessly hard to read or understand (e.g. huge screenshots, not providing a proper description, or addressing multiple topics).
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
## Translation
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.
@ -129,7 +132,8 @@ HeliBoard is a complex application, when contributing, you must take a step back
- **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.
- **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.
- **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.
- **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.
@ -169,7 +173,7 @@ __Planned features and improvements:__
* 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)
* (optionally?) move toolbar key pinning to a setting, so long press actions on unpinned toolbar keys are available
* optionally move toolbar key pinning to a setting, so long press actions on unpinned toolbar keys are available
* [Bug fixes](https://github.com/Helium314/HeliBoard/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
__What will _not_ be added:__

4
layouts.md
View file

@ -41,8 +41,8 @@ Some special key labels will be implemented, most are already working in the (cu
* Allows more flexibility than the simple format, e.g. changing keys depending on input type, shift state or layout direction
* You can use character layouts from [FlorisBoard](https://github.com/florisboard/florisboard/blob/master/CONTRIBUTING.md#adding-the-layout)
* Support is not 100% there yet, notably `kana_selector` and `char_width_selector` do not work.
* There is no need for specifying a code, it will be determined from the label automatically
* You can still specify it, but it's only necessary if you want key label and code to be different
* There is no need for specifying a `code`, it will be determined from the label automatically
* You can still specify it, but it's only necessary if you want key label and code to be different (please avoid contributing layout with unnecessary codes to HeliBoard)
* Note that not all _special codes_ (negative numbers) from FlorisBoard are supported
* You can add the numeric value of a _labelFlag_ to a key for some specific effects, see [here](app/src/main/res/values/attrs.xml) in the section _keyLabelFlags_ for names and numeric values.
* More details on the formal will be provided. For now you can check other layouts, often you just need to copy lines and change the labels.