diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..2729a6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,55 @@ +--- +name: Bug report +about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. + +--- + +**How to post a meaningful bug report** +1. *Read this whole template first.* +2. *Determine if you are on the right place:* + - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* + - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* + - *When in doubt, post here and we will figure it out together.* +3. *Delete the italic comments as you write over them below, and remove this guide.* +--- + +### Describe the bug + +*A clear and concise description of what the bug is.* + +### Context + +- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* +- YunoHost version: x.x.x +- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* +- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* + - If yes, please explain: +- Using, or trying to install package version/branch: +- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* + +### Steps to reproduce + +- *If you performed a command from the CLI, the command itself is enough. For example:* + ```sh + sudo yunohost app install the_app + ``` +- *If you used the webadmin, please perform the equivalent command from the CLI first.* +- *If the error occurs in your browser, explain what you did:* + 1. *Go to '...'* + 2. *Click on '...'* + 3. *Scroll down to '...'* + 4. *See error* + +### Expected behavior + +*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* + +### Logs + +*When an operation fails, YunoHost provides a simple way to share the logs.* +- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* +- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* + +*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* + +*If applicable and useful, add screenshots to help explain your problem.* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ef70e18 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Problem + +- *Description of why you made this PR* + +## Solution + +- *And how do you fix that problem* + +## PR Status + +- [ ] Code finished and ready to be reviewed/tested +- [ ] The fix/enhancement were manually tested (if applicable) + +## Automatic tests + +Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) diff --git a/README.md b/README.md index 55f81aa..58f6007 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # 243 for YunoHost [![Integration level](https://dash.yunohost.org/integration/243.svg)](https://dash.yunohost.org/appci/app/243) ![](https://ci-apps.yunohost.org/ci/badges/243.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/243.maintain.svg) @@ -5,37 +10,31 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install 243 quickly and simply on a YunoHost server. -If you don’t have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +> *This package allows you to install 243 quickly and simply on a YunoHost server. +If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -Clone of 2048 game. You need to reach 243. +2048 game clone + +**Shipped version:** 1.0~ynh5 + +**Demo:** https://hgentry.github.io/81/ ## Screenshots -![](Screenshot-243.jpg) +![](./doc/screenshots/Screenshot-243.jpg) -## Demo +## Documentation and resources -* [Official demo](https://hgentry.github.io/81/) +* Official app website: https://github.com/hgentry/81/ +* Upstream app code repository: https://github.com/hgentry/81 +* YunoHost documentation for this app: https://yunohost.org/app_243 +* Report a bug: https://github.com/YunoHost-Apps/243_ynh/issues -#### Supported architectures +## Developer info -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/243.svg)](https://ci-apps.yunohost.org/ci/apps/243/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/243.svg)](https://ci-apps-arm.yunohost.org/ci/apps/243/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/243_ynh/issues - * Upstream app repository: https://github.com/hgentry/81 - * YunoHost website: https://yunohost.org/ - ---- - -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/243_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/243_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -43,3 +42,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/243_ynh/tree/testing or sudo yunohost app upgrade 243 -u https://github.com/YunoHost-Apps/243_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 76aa641..1ac3e45 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,38 +1,32 @@ # 243 pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/243.svg)](https://dash.yunohost.org/appci/app/243) ![](https://ci-apps.yunohost.org/ci/badges/243.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/243.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/243.svg)](https://dash.yunohost.org/appci/app/243) ![](https://ci-apps.yunohost.org/ci/badges/243.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/243.maintain.svg) [![Installer 243 avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=243) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d’installer 243 rapidement et simplement sur un serveur YunoHost. -Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* +> *Ce package vous permet d'installer 243 rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* -## Vue d’ensemble +## Vue d'ensemble -Clone du jeu 2048. Il vous faut atteindre 243. +Clone du jeu 2048 -## Captures d’écran +**Version incluse :** 1.0~ynh5 -![](Screenshot-243.jpg) +**Démo :** https://hgentry.github.io/81/ -## Démo +## Captures d'écran -* [Démo officielle](https://hgentry.github.io/81/) +![](./doc/screenshots/Screenshot-243.jpg) -#### Architectures supportées +## Documentations et ressources -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/243.svg)](https://ci-apps.yunohost.org/ci/apps/243/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/243.svg)](https://ci-apps-arm.yunohost.org/ci/apps/243/) - - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/243_ynh/issues - * Dépôt de l’application principale : https://github.com/hgentry/81 - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://github.com/hgentry/81/ +* Dépôt de code officiel de l'app : https://github.com/hgentry/81 +* Documentation YunoHost pour cette app : https://yunohost.org/app_243 +* Signaler un bug : https://github.com/YunoHost-Apps/243_ynh/issues ## Informations pour les développeurs @@ -44,3 +38,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/243_ynh/tree/testing ou sudo yunohost app upgrade 243 -u https://github.com/YunoHost-Apps/243_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/check_process b/check_process index 7970cbc..320dec3 100644 --- a/check_process +++ b/check_process @@ -1,9 +1,9 @@ ;; Test complet auto_remove=1 ; Manifest - domain="domain.tld" (DOMAIN) - path="/path" (PATH) - is_public="Yes" (PUBLIC|public=Yes|private=No) + domain="domain.tld" + path="/path" + is_public="Yes" ; Checks pkg_linter=1 setup_sub_dir=1 diff --git a/doc/screenshots/Screenshot-243.jpg b/doc/screenshots/Screenshot-243.jpg new file mode 100644 index 0000000..6db32ac Binary files /dev/null and b/doc/screenshots/Screenshot-243.jpg differ diff --git a/manifest.json b/manifest.json index e66e73e..9332716 100644 --- a/manifest.json +++ b/manifest.json @@ -8,6 +8,12 @@ }, "version": "1.0~ynh5", "url": "https://github.com/hgentry/81/", + "upstream": { + "license": "MIT", + "website": "https://github.com/hgentry/81/", + "demo": "https://hgentry.github.io/81/", + "code": "https://github.com/hgentry/81" + }, "license": "MIT", "maintainer": { "name": "eric_G",