Call for components

[trombik]

Do you have a driver or a component based on esp-idf-lib? Are you willing to write one from scratch?

If you have a driver or a component based on esp-idf-lib, we would like to import yours so that the code is managed by a group of people. In my opinion, drivers should be maintained by a group of people so that bugs are fixed, PRs are merged, and the code is maintained. Your code will be used and scrutinized by more users.

Requirements:

• the code follows our policies (see below).
• the license must be one of acceptable licenses.
• you agree that the code is managed under joint control of esp-idf-lib admins (the repository will be transferred to esp-idf-lib organization.T
• the code is for ICs (not generic graphic drivers or display drivers).

Note

The code will be still yours and you will remain the copyright holder. You will be an admin of the transferred repository.

If you are willing to write one, you can pick one from a list of requested drivers.

Here is our development policies:

• TEMPLATE_README.md
• CONTRIBUTING.md

If you are interested, please reply in this discussion.

[shibcreate]

Hi @trombik and esp-idf-lib community,

I’m an avid ESP32 user and new contributor interested in helping with driver development, creating one from scratch. I’ve read the guidelines and understand the contribution process.

Which drivers are top priority, and what’s the best first step to get started?

Thank you!

[trombik]

Thanks. Please follow the instruction at: TEMPLATE_README.md. The document is recently written from scratch and it might contain bugs. Please ask me here if you have questions. I will help.

Simply put, the process is:

• Create a repository from the template
• Let me know the URL of the repository so that I can subscribe to the repository notification
• Write code
• Write an example under examples directory
• Let me know when the code is working and all the CI workflows except "Publish ..." pass. I will review the component

The template-component is a working example. It should work out of the box.

[shibcreate]

Sounds great. Thank you! I am planning to start developing in a week. Will keep you posted if I run into any issues.