Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cull examples #2513

Closed
MabezDev opened this issue Nov 11, 2024 · 5 comments
Closed

Cull examples #2513

MabezDev opened this issue Nov 11, 2024 · 5 comments
Assignees
Milestone

Comments

@MabezDev
Copy link
Member

The examples have grown beyond what is maintainable. Whilst longer term, we will want to move to a more "project" based list of examples, we can improve what we have here by culling useless ones.

I think if the following criteria is met, we can remove the example:

  • The example is basic in nature, just initializing the driver and basic usage
  • The driver has docs to explain the initialization/basic usage
  • The driver has at least one test in hil-test
@MabezDev MabezDev added this to the 0.22.0 milestone Nov 11, 2024
@jessebraham
Copy link
Member

I'll also add that if a driver does not have adequate documentation to demonstrate initialization and use of the peripheral, but this is all the example is doing, we should just update the relevant documentation and then purge the example :)

@Dominaezzz
Copy link
Collaborator

Is the thinking here that any new drivers introduced don't need to have examples, as long as they have docs describing basic usage and at least one HIL test, then it's fine to land? (I have a specific PR in mind and I'm trying to figure out if the example is basic or not)

@MabezDev
Copy link
Member Author

We discussed this a bit today, we should move "examples" that are actually manual tests (not something we can test in HIL, like displays) into their own project/directory.

Is the thinking here that any new drivers introduced don't need to have examples, as long as they have docs describing basic usage and at least one HIL test, then it's fine to land? (I have a specific PR in mind and I'm trying to figure out if the example is basic or not)

If it's #2415, we'd probably need one of those manual tests for this (that we can run on the official espressif devkit).

@playfulFence
Copy link
Contributor

I'll start sorting through the examples a little by little.
If anyone wants to take a part - let me know first so we can avoid working on the same thing 🤝

@MabezDev
Copy link
Member Author

Closed via #2547, we'll need to work more on examples in the future, but culling these useless ones has been a good start!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

No branches or pull requests

4 participants