Contributing#

If you would like to contribute to the Edge Orchestrator project, see the following technical and administrative steps.

See the following documents for more detail on steps a developer would take to contribute:

Improve Documentation#

The easiest way to help with documentation, including the Developer Guide and User Guide, is to review it and provide feedback on the existing articles. Whether you notice a mistake, see the possibility of improving the text, or think more information should be added, you can reach out to discuss the potential changes.

See the edge-manage-docs README for instructions on testing and building the documentation

Report Bugs#

If you encounter a bug, open an issue on the GitHub* repository. Provide the following information to help us understand and resolve the issue quickly:

  • 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 Enhancements#

Intel welcomes suggestions for new features and improvements. Follow these steps to make a suggestion:

  1. Check if there’s already a similar suggestion in the GitHub issues.

  2. If not, open a new issue and provide the following information:

    • A clear and descriptive title

    • A detailed description of the enhancement

    • Use cases and benefits

    • Any additional context or references