Home

HOW TO CONTRIBUTE

If you have an OEM issue that you'd like to share with others, please follow these steps:

1. Go to the discussions section of the repository and create a new discussion
2. Choose the category that you think is the most relevant to your issue
3. Compose your issue report according to the following format:

• Summary

• Related APIs, libraries and/or classes

• Problematical devices (e.g. Samsung Galaxy Note 9 / OneUI2 Android 10)

• Procedure / Technical Context

• Expected result / Result on other devices

• Results on problematic devices

• Related Stackoverflow questions (if any)

• Solutions / Workarounds (if any)

  Here is an example

4. Fork the repository. Go to the file issues.json under data folder

+--css
+--data
---+--issues.json <-- The file to modify to contribute
+--imgs
+--js
+--theme
+--index.html 

5. Copy the following piece of JSON and edit it with your own data:

    {
        "shortDescription": "TextToSpeech gives out robotic voice on Samsung devices",
        "relatedClass": "android.speech.tts.TextToSpeech",
        "tags": [
          "texttospeech",
          "samsung",
          "robotic"
        ],
        "devices": [
          {
            "brand": "Samsung",
            "model": "Galaxy Note Fan Edition",
            "OSVersion": "OneUI 1 Android 9"
          },
          {
            "brand": "Samsung",
            "model": "Galaxy Note 9",
            "OSVersion": "OneUI 2 Android 10"
          }
        ],
        "linkToDiscussion": "https://github.com/OyaCanli/awesome-android-oem-issues/issues/2"
      }

This piece of JSON represents an oem-issue in the JSON. Notice that JSON consists of a list of topics, each of which contains a list of issues related to that topic. If the topic related to your issue already exists in the JSON, please put your issue within the issues array of that topic.

If you couldn't find the related topic, first try to choose a good topic name for your issue. Best fit would be the related api or library. Here are some examples: Bluetooth, Camera, Google Maps, Geofencing, NFC, Jetpack Navigation, WorkManager, Accelerometer, WiFiManager, Navigation, View, Style, Animators, Motion Layout… Then create a new topic in the JSON and add your issue as follows:

{
    "topic": "TextToSpeech",
    "issues": [
      {
        "shortDescription": "TextToSpeech gives out robotic voice on Samsung devices",
        "relatedClass": "android.speech.tts.TextToSpeech",
        "tags": [
          "texttospeech",
          "samsung",
          "robotic"
        ],
        "devices": [
          {
            "brand": "Samsung",
            "model": "Galaxy Note Fan Edition",
            "OSVersion": "OneUI 1 Android 9"
          },
          {
            "brand": "Samsung",
            "model": "Galaxy Note 9",
            "OSVersion": "OneUI 2 Android 10"
          }
        ],
        "linkToDiscussion": "https://github.com/OyaCanli/awesome-android-oem-issues/issues/2"
      }
    ]
  }

Notice that this new topic will go directly inside the root.

6. Verify JSON structure(don't forget to add commas between objects in the list), commit and make a PR.

Thank you!