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

Docs: Fix Arduino as IDF Component instructions #9001

Merged

Conversation

lucasssvaz
Copy link
Collaborator

Description of Change

Fix the instructions for using Arduino as an IDF component. Current instructions are not up-to-date and might lead to confusion.

Copy link
Contributor

github-actions bot commented Dec 14, 2023

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Docs: Fix Arduino as IDF Component instructions":
    • type/action should start with a lowercase letter
    • type/action should be one of [change, ci, docs, feat, fix, refactor, remove, revert, test]

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello lucasssvaz, we appreciate your contribution to this project!


Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against bf07827

@lucasssvaz lucasssvaz added Type: Documentation Issue pertains to Documentation of Arduino ESP32 Area: Arduino as ESP-IDF component Issues about Arduino used as component in ESP-IDF labels Dec 14, 2023
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good :)

@lucasssvaz lucasssvaz added the Status: Pending Merge Pull Request is ready to be merged label Dec 18, 2023
@lucasssvaz lucasssvaz self-assigned this Jan 8, 2024
@me-no-dev
Copy link
Member

please fix the conflict @lucasssvaz

@VojtechBartoska VojtechBartoska merged commit c0c687c into espressif:master Jan 17, 2024
40 checks passed
@lucasssvaz lucasssvaz deleted the doc/fix_arduino_as_component branch February 7, 2024 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Arduino as ESP-IDF component Issues about Arduino used as component in ESP-IDF Status: Pending Merge Pull Request is ready to be merged Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants