[heads up] We moved! No new issues here

[trombik]

The issue

We do not accept any issues anymore. Sorry. Instead, please wait until we finish the migration. We will announce once it completes.

Note

The new repositories are ready to accept PRs and Issues. Access repositories from esp-idf-lib/core.

You might have found a bug in our code and came here. However, we will move to an GitHub organization, esp-idf-lib. All the components in this repository will migrate, too. Until then, we stop accepting issues. When all the repositories are ready, please open an Issue in the relevant repository.

You MAY open an Issue here if the issue has nothing to do with the code.

Benefits

• Each component has its own repository. Faster build, simpler CI, easier to add more components
• ESP Component Registry integration. No need to import the whole repository.

This repository is owned by @UncleRus. Not mine. I have not been active on the project, but it seems like, I am the only one who can move the project forward. If you are willing to maintain the project, please help me. There are many remaining issues you can help.

The context

No response

Possible solution

No response

Confirmation

• This report is not a bug report in code, a question, nor a request for drivers.

[xyzroe]

Hello!
What about PR for issues that have already been opened? Should I wait until all the code is moved, or can I make a PR now?
For example #695 #696 #706

[trombik]

@xyzroe

You can open issues or PRs in the new repositories. I'll request updates in the remaining issues and PRs soon.

[xyzroe]

However, since my PRs are new components, I need to create new repositories.
Is it possible right now?

[trombik]

@xyzroe

Sure, it is possible.

1. fork the component repository (NOT "core" repository)
2. create a branch and commit your fix to the branch
3. push to your repository on GitHub
4. make sure the fix work by using your own project by making your project depends on your component with git (see Defining Dependencies in the Manifest, you can use git to choose your repository as a source)
5. create a PR

[trombik]

@xyzroe

Note that you need:

git submodule update --init --recursive

after git clone.

[xyzroe]

1. fork the component repository (NOT "core" repository)

What repository should I fork when I need to create a new repo for a new component?

[trombik]

I just sent an invitation to the organization.

[trombik]

@xyzroe

Please create a new repository from this repository: https://github.com/esp-idf-lib/template-component

[trombik]

I have not finished how to create a component, but here is the basic:

1. create a new repository. Choose the template repository as a source
2. copy the header files under include
3. copy the source C files under the top directory
4. create an example under examples (there are example1 and example2 but you can safely remove them)

[trombik]

here is the work-in-progress: https://github.com/esp-idf-lib/template-component/blob/main/TEMPLATE_README.md

[trombik]

In the doc, please ignore "Obtain an access token of ESP Component Registry" section. it is not relevant for now.

[xyzroe]

Thanks. I'll try later.

[trombik]

@xyzroe

Here is one ported from a PR.
https://github.com/esp-idf-lib/bmi160/commits/main/

Hope it would not be complicated.