Skip to content

Latest commit

 

History

History
146 lines (116 loc) · 4.72 KB

CONTRIBUTING.md

File metadata and controls

146 lines (116 loc) · 4.72 KB

Contributing to awesome-qualcomm-developer

Hi there! We’re thrilled that you’d like to contribute to this project.

Contribution Types

There are two main contributions that we're accepting in this repo: new project/repo entries and general site fixes.

Adding a new repo entry

For adding new repos, find the relevant platform file for your project (or add a new one) and add the JSON entry there. The current platform files are as follows:

  • data/repos-cloud.json
  • data/repos-compute.json
  • data/repos-iot.json

Be sure to include all of the required details for your entry using the following example:

{
    "name": "rubik-tflite",
    "link": "https://github.com/ramalamadingdong/rubik-tflite",
    "description": "Demonstrates how to use TFLite and QNN delegate with Rubik Pi",
    "author": "ramalamadingdong",
    "lastUpdated": "2025-07-01",
    "stars": 3,
    "language": "Python",
    "tags": [
        "tflite",
        "image transformation",
        "image processing",
        "machine learning",
        "ai hub"
    ],
    "platforms": [
        "Dragonwing IoT"
    ],
    "isShowcase": true,
    "categories": [
        "AI & Machine Learning",
        "Edge AI & IoT",
        "Image Processing",
        "Computer Vision"
    ]
}

For categories, please select one or more from the following list:

  • AI & Machine Learning
  • Assessment
  • Assistive & Accessibility Tech
  • Audio
  • Automation
  • Backend
  • Career & Recruitment
  • Cloud & Web
  • Collection
  • Communication
  • Computer Vision
  • Edge AI & IoT
  • Education & Learning
  • Entertainment & Creativity
  • Food & Cooking
  • Frontend
  • Hackathon & Innovation
  • Hackathon
  • Health & Wellness
  • Image Processing
  • Inference
  • Language Models
  • Media
  • NLP
  • Notebook
  • Object Detection
  • On-device AI
  • Privacy
  • Productivity & Automation
  • Prototype
  • Recommendation
  • Social Good
  • Speech
  • Teamwork
  • User Interaction & Interface
  • Wearable
  • Web

At present, tags are not used, but they may be in the future so plan accordingly.

Site updates

For general fixes to the site structure (html, css, js) please provide as much detail as possible when submitting your PR, including details on what, why, and how your changes were tested.

Branching Strategy

In general, contributors should develop on branches based off of main and pull requests should be made against main.

Submitting a pull request

  1. Please read our code of conduct and license.

  2. Fork and clone the repository.

    git clone https://github.com/<username>/awesome-qualcomm-developer.git

  3. Create a new branch based on main:

    git checkout -b <my-branch-name> main

  4. Create an upstream remote to make it easier to keep your branches up-to-date:

    git remote add upstream https://github.com/qualcomm/awesome-qualcomm-developer.git

  5. Make your changes, add tests, and make sure the tests still pass.

  6. Commit your changes using the DCO. You can attest to the DCO by commiting with the -s or --signoff options or manually adding the "Signed-off-by":

    git commit -s -m "Really useful commit message"`

  7. After committing your changes on the topic branch, sync it with the upstream branch:

    git pull --rebase upstream main

  8. Push to your fork.

    git push -u origin <my-branch-name>

    The -u is shorthand for --set-upstream. This will set up the tracking reference so subsequent runs of git push or git pull can omit the remote and branch.

  9. Submit a pull request from your branch to main.

  10. Pat yourself on the back and wait for your pull request to be reviewed.

Here are a few things you can do that will increase the likelihood of your pull request to be accepted:

  • For new repos, follow the existing structure and use the correct platform file (if your project supports multiple Qualcomm platforms, just pick one)
  • For site fixes, please provide information on how it was tested
  • Keep your change as focused as possible. If you want to make multiple independent changes, please consider submitting them as separate pull requests.
  • Write a good commit message.
  • It's a good idea to arrange a discussion with other developers to ensure there is consensus on large features, architecture changes, and other core code changes. PR reviews will go much faster when there are no surprises.