Skip to content

Latest commit

 

History

History
91 lines (73 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

91 lines (73 loc) · 3.22 KB
Raw

CONTRIBUTING

Plexus is only for applications directly or indirectly from the Google Play Store. Please do not submit applications from F-Droid as they are all expected to work.

Contents

Contributing to the data

Add new apps

Ensure you're adding new applications in alphabetical order to make merging as simple as possible.

The general format to add new applications is as follows:

{
  "Application": "Application name",
  "Package": "Package name of the application",
  "Version": "Version of the application",
  "DG_Rating": "Degoogled rating for the application",
  "MG_Rating": "MicroG rating for the application",
  "DG_Notes": "Degoogled notes for the application",
  "MG_Notes": "MicroG notes for the application"
}

Testing Standards

  • Test only Google Play Store applications (Regardless of where they came from, including the Aurora Store)
  • Kindly disable Netguard and other blockers
  • No Google Play Services. Plexus evaluates MicroG, or nothing. Plexus assumes all variants of Google Play Services (ex. Sandboxed Play Services, OpenGApps, etc.) will function without issues for compatibility.
  • Pay extra attention to notifications as some will not properly work. If you're testing on MicroG, it is assumed you have enabled GCM/FCM. If you have not enabled GCM/FCM, you are still free to report applications, but please exclude any information regarding missing notifications. (Notifications working is okay and encouraged even with GCM/FCM disabled.)
  • If you're testing with MicroG only, input data in the MG_Rating and MG_Notes. Enter "X" in both DG_Rating and DG_Notes.
  • If you're testing with a fully de-googled ROM only without MicroG, input data in the DG_Rating and DG_Notes. Enter "X" in both MG_Rating and MG_Notes.
  • We check all data for accuracy as best we can, and ultimately hold the right to turn down a submission if we feel it wasn't tested properly. Generally, we will follow up with individuals for clarification when necessary.

Example

Assuming Twitter as the app for example here.

  • Tested with both Degoogled ROM and MicroG:
{
  "Application": "Twitter",
  "Package": "com.twitter.android",
  "Version": "9.41.0",
  "DG_Rating": "3",
  "MG_Rating": "3",
  "DG_Notes": "No notifications",
  "MG_Notes": "No notifications"
}
  • Tested with Degoogled ROM only, without MicroG:
{
  "Application": "Twitter",
  "Package": "com.twitter.android",
  "Version": "9.41.0",
  "DG_Rating": "3",
  "MG_Rating": "X",
  "DG_Notes": "No notifications",
  "MG_Notes": "X"
}
  • Tested with MicroG only:
{
  "Application": "Twitter",
  "Package": "com.twitter.android",
  "Version": "9.41.0",
  "DG_Rating": "X",
  "MG_Rating": "3",
  "DG_Notes": "X",
  "MG_Notes": "No notifications"
}

Contributing to the app

  • Try to stick to the project's existing code style and naming conventions.
  • Do not use any deprecated libraries, dependencies or methods.
  • Make sure the characters are properly encoded when translating strings (example: ä as \u00E4, é as \u00E9 etc).