Contributing to Open Edge Platform#

Open Edge Platform comprises multiple components, developed in various repositories. Note that different repositories may follow slightly different rules. Make sure to check whether the repository you are interested in provides additional information in README, LICENSE, CONTRIBUTING, and CODE_OF_CONDUCT documents.

The project follows Intel principles of security and ethical AI use.

Repository Cloning / Partial Cloning#

If your chosen component is part of a monolithic repository, you may choose to clone just the directory relevant to you, saving time, internet bandwidth, and storage space. You can do it with filtered clone and Sparse Checkout.

Here’s how you can use it, based on the example of the Metro AI Suite.

  1. Using the terminal (make sure you have Git Bash available), go to the folder where you want your clone to be located, for example:

    cd c:GH_repos

  2. Clone the repository, filtering out files beyond metadata and checking out only the root directory.

    git clone --filter=blob:none --sparse  https://github.com/open-edge-platform/edge-ai-suites

  3. Open the newly created folder.

    cd edge-ai-suites

  4. Check out the directory you want to work on.

    git sparse-checkout add metro-ai-suite

  5. (Optional) Add more folders or files to the repository.

    git sparse-checkout add manufacturing-ai-suite
git sparse-checkout add education-ai-suite/README.md

How Can I Contribute?#

Report Bugs#

If you encounter a bug, you can report it in the Issues section of the app’s repository. Before opening a new issue, make sure one has not already been open for the same problem. The following elements will help address the issue:

  • A clear and descriptive title

  • A thorough description of the issue

  • Steps to reproduce the issue

  • Expected versus actual behavior

  • Screenshots or logs (if applicable)

  • Your environment (OS, browser, etc.)

Suggest Improvements#

If you have an idea for improving the app but cannot develop it yourself, you can always suggest it to the developer community. Always make sure a similar recommendation has not been filed already. If not, open a GitHub issue in the respective repository. For best results, add:

  • A clear and descriptive title.

  • A detailed description of the enhancement.

  • Use cases and benefits.

  • Any additional context or references.

Improve Documentation#

The easiest way to help is to review the User Documentation published at docs.openedgeplatform.intel.com. If you notice a mistake, see the possibility of improving the content, or think more information should be added, you can either propose changes by creating a PR, or reach out to the Documentation Team, to discuss the improvements.

Commit Code#

If you want to contribute to the code base of an application, you can either propose your own improvement, or volunteer for an existing task in the Issues section of the applications’s repository. In case of any doubts, it is always a good idea to ask active developers for guidance. When creating a PR, make sure to follow the project guidelines.

How to Contribute Code / Documentation#

  • Check if the repository includes a CONTRIBUTING guide for project-specific guidelines and coding standards.

  • Fork the repository and create your branch from main.

  • Test your changes thoroughly.

  • Document your changes in both code and user-guide documents.

  • Submit your pull request, detailing the changes and linking to any relevant issues.

  • Wait for a review. Maintainers will review your pull request as soon as possible and provide you with feedback. Be patient, they may need to prioritize other tasks before addressing your Pull Request.