Skip to content

Latest commit

 

History

History
97 lines (50 loc) · 5.42 KB

APP_CRITERIA.md

File metadata and controls

97 lines (50 loc) · 5.42 KB

App Criteria

Before opening a new app request/PR with updates to a config, please read the following information to ensure that the app you want is suitable for this site. It will save you and the maintainers of the repo time. If you choose to ignore these instructions, your request/PR may be ignored.

Before opening an app request:

  1. Check the config website to see if the app you want is already available there.

  2. Search in both open AND closed discussions to see if this app has already been requested by someone else.

  3. Do not request apps that are simple configs - see below.

  4. Forks of apps will not be accepted, unless both the package name and display name of the app has been changed. This is so people do not unknowingly download unofficial versions of apps.

  5. Only configs from official sources from the app are accepted. This means reupload site (eg. APKPure, APKMirror etc...) configs will NOT be added.

If you've gone through the above steps, then you can open an app request. Make sure to include at a minimum:

  • The link from where you can download the APK.
  • What you have tried to get the app working so far. If you have a working config, consider creating a PR yourself.

Before opening a PR:

  1. Search in both open AND closed PRs to see if someone has already tried to add the app at some point, and if it was declined, the reason why.

  2. Do not add apps that are simple configs - see below.

  3. Forks of apps will not be accepted, unless both the package name and display name of the app has been changed. This is so people do not unknowingly download unofficial versions of apps.

  4. Only configs from official sources from the app are accepted. This means reupload site (eg. APKPure, APKMirror etc...) configs will NOT be added.

If you've gone through the above steps, then you can open an PR. Keep these things in mind:

  • Keep the amount of alternative configs to a minimum, only provide the ones that will work the best in the long term.
  • Ensure that you leave as many config options as you can as the default setting. Only change what you need. For example, with a GitHub config you would not add an app with the Include prereleases setting enabled unless necessary as not everyone will want prereleases.

What is a simple config?

A simple config is an app that you can add by simply pasting the URL of the website and clicking add in Obtainium, without changing any additional settings.

The exception to this is if the URL may be hard to find. For example, the URL which has the links to Signal APKs (https://updates.signal.org/android/latest.json) is not easy to find unless you have knowledge of browser developer tools.

应用标准

在提交更新配置的新应用请求/PR 之前，请阅读以下信息，以确保您想要的应用适合本网站。这将节省您和软件仓库维护者的时间。如果您选择忽略这些说明，您的请求/PR 可能会被忽略。

打开应用请求之前：

  1. 检查配置网站，查看您想要的应用是否已经可用。

  2. 在已打开和已关闭的讨论中搜索，查看是否已有提出过的该应用请求。

  3. 请勿申请简单配置的应用——见下文。

  4. 除非软件包名称和显示名称都已更改，否则不会接受应用的分支。这是为了避免人们在不知情的情况下下载非官方版本的应用。

  5. 只接受来自应用官方源的配置。这意味着不会添加第三方下载站（如 APKPure、APKMirror 等……）的配置。

如果您已完成上述步骤，则可以打开应用请求。请确保至少包含：

  • 您可以下载 APK 的链接。
  • 到目前为止，您为使应用正常运行所做的尝试。如果您的配置可以正常运行，请考虑自行创建 PR。

在创建 PR 之前

  1. 在已打开和已关闭的 PR 中搜索，看看是否有人曾尝试添加该应用，如果被拒绝，请查看原因。

  2. 请勿添加简单配置的应用——见下文。

  3. 除非软件包名称和显示名称都已更改，否则不会接受应用的分支。这是为了避免人们在不知情的情况下下载非官方版本的应用。

  4. 只接受来自应用官方源的配置。这意味着不会添加第三方下载站（如 APKPure、APKMirror 等……）的配置。

如果您已完成上述步骤，那么就可以开启 PR。请牢记以下几点：

  • 尽量减少备选配置的数量，只提供长期效果最好的配置。
  • 确保将尽可能多的配置选项保留为默认设置。只更改需要的配置。例如，在 GitHub 配置中，除非有必要，否则不会在添加应用时启用“包含预发布版本”设置，因为不是每个人都需要预发布版本。

什么是简单配置？

简单配置是指只需粘贴网站链接在 Obtainium 中，无需更改任何其他设置，单击添加即可添加的应用。

如果链接难以找到，则属于例外情况。例如，除非您了解浏览器开发工具，否则很难找到包含 Signal APK 的链接。