search

espressif / arduino-esp32

Arduino core for the ESP32
GNU Lesser General Public License v2.1
13.71k stars 7.43k forks source link

fix(typo): Fix typo in CDC DFU flash tutorial #10584

Closed jurstu closed 1 week ago

jurstu commented 2 weeks ago

Fixing a small typo

Checked the whole checklist, just fixing a typ0.

CLAassistant commented 2 weeks ago

CLA assistant check
All committers have signed the CLA.

github-actions[bot] commented 2 weeks ago
Warnings
:warning: **Some issues found for the commit messages in this PR:** - the commit message `"Update cdc_dfu_flash.rst"`: - *summary* looks empty - *type/action* looks empty - the commit message `"Update docs/en/tutorials/cdc_dfu_flash.rst"`: - *summary* looks empty - *type/action* looks empty - the commit message `"Update docs/en/tutorials/cdc_dfu_flash.rst"`: - *summary* looks empty - *type/action* looks empty *** **Please fix these commit messages** - here are some basic tips: - follow [Conventional Commits style](https://www.conventionalcommits.org/en/v1.0.0/) - correct format of commit message should be: `(): `, 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](https://github.com/espressif/conventional-precommit-linter)).
Messages
:book: You might consider squashing your 3 commits (simplifying branch history).

👋 Hello jurstu, 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 :no_entry_sign: dangerJS against 73d941da81ac8cefa42c95672fc293bd86f520ff

jurstu commented 2 weeks ago

Do I need to do any action to move this forward?

lucasssvaz commented 2 weeks ago

Do I need to do any action to move this forward?

No. We will merge this soon.