espressif / esptool

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

Fix typos (ESPTOOL-853) #977

Closed BoryaGames closed 6 months ago

BoryaGames commented 6 months ago

Just fix typos in comment.

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 6 months ago
Messages
:book: 🎉 Good Job! All checks are passing!

👋 Hello BoryaGames, 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.
- 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 918cac7e898372ef618591d23547beda8c9690d2

radimkarnis commented 6 months ago

Hello @BoryaGames, thanks for the contribution! We had a very similar PR quite recently, please see the discussion and my suggestions here: https://github.com/espressif/esptool/pull/974

To sum up: 1) please change the commit message according to the bot report

the commit message "Two typos":
summary looks empty
type/action looks empty

2) please rebase on top of master

The we can merge it!

BoryaGames commented 6 months ago

Hello @radimkarnis, sorry, can you help me how to change commit message and rebase? I'm not really good with GitHub.

radimkarnis commented 6 months ago

I would suggest learning some basic workflows with the git versioning system (using a GUI client or on the command line).

1) You can clone your repository BoryaGames:master and then run the git commit --amend command to change the commit message. The you push the changes with git push --force. Instructions here.

2) Rebasing on GitHub is easy, just go to your repo BoryaGames:master and look for the This branch is 1 commit ahead of, 2 commits behind espressif/esptool:master. message. Then click the Sync fork button next to it. Instructions here.

BoryaGames commented 6 months ago

Done, @radimkarnis, I did what you asked.

radimkarnis commented 6 months ago

Thank you @BoryaGames, I am sorry, but the commit message is still not ok. We follow conventional commits style of commit messages. Everything is explained in the bot report above. Please try to come up with a suitable commit message. I suggest something like change(detect_chip): Fixed a spelling mistake.

Also, now there are two commits for a single change. Can we get rid of the merge commit? Thank you.

BoryaGames commented 6 months ago

Done, @radimkarnis. I merged these commits and changed message.

radimkarnis commented 6 months ago

@BoryaGames thank you for the contribution! Your commit is now merged.