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

example: Matched pin numbers in docs to numbers in variants files #9422

Merged
merged 4 commits into from
Mar 27, 2024

Conversation

lbernstone
Copy link
Contributor

@lbernstone lbernstone commented Mar 26, 2024

Description of Change

Matched pin numbers in doco to numbers in variants files. This should make it easier to use the examples as is. Also added entries for the new variants. Changed SD examples to make REASSIGN_PINS more transparent. Fixes #9082

Tests scenarios

Tested on esp32-c3.

Copy link
Contributor

github-actions bot commented Mar 26, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Changed SD examples to make REASSIGN_PINS more transparent. Fixes #9082":
    • summary looks empty
    • type/action looks empty
  • the commit message "Matched pin numbers in doco to numbers in variants files":
    • summary looks empty
    • type/action looks empty
  • the commit message "Non-breaking dashes":
    • summary looks empty
    • type/action looks empty

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).

Messages
📖 You might consider squashing your 4 commits (simplifying branch history).

👋 Hello lbernstone, 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 bb2a1a2

@me-no-dev me-no-dev added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Mar 26, 2024
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.

LGTM!

@P-R-O-C-H-Y P-R-O-C-H-Y added the Status: Pending Merge Pull Request is ready to be merged label Mar 27, 2024
@me-no-dev me-no-dev merged commit 654aead into espressif:master Mar 27, 2024
39 checks passed
@VojtechBartoska VojtechBartoska changed the title Matched pin numbers in doco to numbers in variants files example: Matched pin numbers in docs to numbers in variants files Apr 12, 2024
@lbernstone lbernstone deleted the fix_sd_pins branch June 6, 2024 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

esp32c3 SPI SD can't not work
3 participants