espressif / esptool

Espressif SoC serial bootloader utility
https://docs.espressif.com/projects/esptool
GNU General Public License v2.0
5.6k stars 1.39k forks source link

Fixed Spelling Mistake (ESPTOOL-850) #974

Closed greendoescode closed 7 months ago

greendoescode commented 7 months ago
I fixed a spelling mistake in the docs, it spelled something instead of devices. # This change fixes the following bug(s): # I have tested this change with the following hardware & software combinations: NO TESTING # I have run the esptool.py automated integration tests with this change and the above hardware: NO TESTING
github-actions[bot] commented 7 months ago
Warnings
:warning: **Some issues found for the commit messages in this PR:** - the commit message `"docs(flashing): Fixed a typo"`: - *summary* looks too short - the commit message `"docs(flashing): Fixed a typo"`: - *summary* looks too short *** **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 GreenDiscord, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

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 via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

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 synchronize it into our internal git repository.
4. In the internal git repository 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.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by :no_entry_sign: dangerJS against cef6305773bce2a080b647ee6d8ea187ce694ef0

radimkarnis commented 7 months ago

Hello @GreenDiscord, thank you for the contribution and for noticing the spelling mistake!

We'll merge it soon, I just need you to change the commit message (please see the previous message from our bot).

I suggest something like docs(flashing): Fixed a typo.

Thank you!

greendoescode commented 7 months ago

@radimkarnis there ya go :D First time changing a commit message properly, sorry for taking a sec.

radimkarnis commented 7 months ago

Thanks! All looks good now. I will put this through our internal queue and merge it.

radimkarnis commented 7 months ago

Hey @GreenDiscord, sorry to give you a headache over a simple PR.

Turns out your commit is not on top of the current master branch. Could you please rebase? I could do that for you, but then you would lose the github credit for the contribution (since I would alter your commit).

Also, my suggestion of the docs(flashing): Fixed a typo commit message is not correct. Turns out, the commit message checker still doesn't like it (see the summary looks too short message above). Sorry about that 😊 if you'll be rebasing this, you can also deal with this by extending the commit message. But that's not a deal breaker, just a suggestion from our system.