Home
Welcome to the ESP-IDF project on GitHub. This p 80AD age provides non-technical information w.r.t. ESP-IDF issue tracker work scope, workflow processes and etc.
The roadmap of ESP-IDF is available here, and will update at least once in a year, to share the planning for the coming year. By openly sharing this information, we aim to enhance our customers' understanding, promote transparency and ensure alignment with the overarching objectives of the ESP-IDF project.
This section outlines what is considered part of the development and maintenance activities for the ESP-IDF project, which includes:
- Bug Fixes: resolving issues that affect the stability and/or functionality of ESP-IDF platform.
- New Features: implementing new capabilities and improvements for ESP-IDF framework.
- New Chip: introducing support for new chip into ESP-IDF framework
- Performance Enhancements: optimizing the platform for better performance, including speed and resource utilization etc.
- Documentation Updates: improving or adding new documentation for ease of use and understanding.
- Compatibility Issues: addressing issues related to software or firmware compatibility.
Sometimes, issues arise that fall outside the official scope of the ESP-IDF project. These could include:
- Issues related to third-party libraries not included with ESP-IDF.
- Requests that don't directly align with the objectives of the project, e.g. issues related to hardware design/reviewing and certification support, or request for applying samples and information of new silicon and etc.
- Feature requests that are considered too niche for general use.
For issues that fall outside the scope of the ESP-IDF project, the following strategy is applied:
-
Close: issues that are not relevant or outside the scope will be closed with a note explaining why they are not being pursued, and moreover
- For issues related to hardware design/reviewing and certification support, please use Espressif service Circuit Schematic & PCB Design Review
- For issues related to Espressif Hardware Documentation, e.g. datasheets, technical reference manual, certificate guide etc., please click the Submit Documentation Feedback button on any page of the documentation
- For services like get samples, privacy-sensitive issues, information of new silicon etc., please Contact Sales
- Transfer: if the issue is not related to ESP-IDF but still relevant to other Espressif Systems repositories, we will transfer the ticket to the appropriate repository for further support.
- Redirect: If the issue is related to a third-party library or service, the contributor may be directed to the appropriate repository or community for further support, and the issue in ESP-IDF issue tracker will be closed.
ESP-IDF Issue Tracker on GitHub is crucial to the development and improvement of ESP-IDF, where we could receive reports of bugs and feature requests from users worldwide, have discussions directly and efficiently which contributes to faster and more transparent issue resolution process. ESP-IDF Issue Tracker is so important that we would like to share the support workflow how issues are tracked, processed, and resolved within the ESP-IDF project.
For every issue or PR opened on ESP-IDF Issue Tracker on GitHub, it will be mirrored to IDFGH, which is our internal Jira project for storing issue reports of ESP-IDF project on GitHub, hence you can see IDFGH-xxxxx at the end of the issue/PR summary.
This internal project has the workflow as shown below, basically containing statuses of Opened, Selected For Development, In Progress, Reviewing and Done. “All” in the workflow means that the status could be changed to from all other statuses.
Here are the terms and definitions of the workflow.
-
Opened
- This is the initial state of an issue or pull request (PR) after it has been created. It indicates that the issue is not reviewed or awaits attention from ESP-IDF project team.
-
Selected For Development
- The issue has been acknowledged as a valid problem or feature request, and work is planned to address it.
-
In Progress
- Development or troubleshooting for the issue is actively taking place. At this stage, a fix or implementation is being worked on.
-
Reviewing
- The issue fix or feature development is under internal reviewing. At this stage, the development work is complete, and the solution is being reviewed by other contributors or maintainers to ensure it meets the project's standards and guidelines.
-
Done
- The issue fix or feature development has been successfully resolved or merged internally. All discussions, tests, and quality checks have been completed, and no further work is required.
- There might be some latency between the internal merging and its synchronization to GitHub, that is why users can see label "Status: Done" on GitHub but don’t find the fix commit referenced. This is what we have been working on improving.
But note that even if issue is in Selected For Development, In Progress or Reviewing status, we cannot guarantee a resolution timeline for this issue due to its complexity, associated uncertainties, and the possibility of higher-priority issues taking precedence in the queue.
The status change of a ticket in the project is synchronized to the corresponding GitHub issue ticket and represented by labels
- "Status: Opened" on GitHub = Opened status in Jira
- "Status: Selected For Development" on GitHub = Selected For Development status in Jira
- "Status: In Progress" on GitHub = In Progress status in Jira
- "Status: Reviewing" on GitHub = Reviewing status in Jira
- "Status: Done" on GitHub = Done status in Jira
Your feedback matters! We value feedback that helps improve ESP-IDF, including general suggestions as well as issues, features, or pull requests. Feel free to report in the ESP-IDF Issue Tracker or write to sales@espressif.com.
We hope this wiki helps you navigate the ESP-IDF GitHub repository and contributes to a smooth and productive experience for everyone involved. Thank you for contributing to the ESP-IDF project!