-
-
Notifications
You must be signed in to change notification settings - Fork 95
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into lang_swipe_sensitivity
- Loading branch information
Showing
345 changed files
with
5,422 additions
and
3,328 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
Oops, something went wrong.