search

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

Add monthly downloads badge to README (ESPTOOL-876) #986

Closed Aman-Clement closed 5 months ago

Aman-Clement commented 5 months ago

Added a monthly downloads badge by pip Trends to the README. View more at - https://piptrends.com/widgets/esptool

github-actions[bot] commented 5 months ago
Warnings
:warning: **Some issues found for the commit messages in this PR:** - the commit message `"Update README.md - add monthy downloads badge"`: - *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)).

👋 Hello Aman-Clement, 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.
- 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 ab495d3f85cfab1a2485c361d70e01b42a751b08

radimkarnis commented 5 months ago

Hello @Aman-Clement, thank you for the contribution, it is always appreciated!

In this case, we don't really care about communicating how many monthly downloads esptool has. Also, this adds a dependency on an external service (piptrends.com).

I am sorry, but for this reason and to keep things simple and tidy, we would rather not accept this PR.

Aman-Clement commented 5 months ago

Hey @radimkarnis Thanks for the review! I understand the desire to keep things simple, thank you for your time. If there's any future interest in exploring download count features, feel free to reach out.

radimkarnis commented 5 months ago

@Aman-Clement thanks for understanding!

If there's any future interest in exploring download count features, feel free to reach out.

Will keep you in mind 😊

ixmatus commented 5 months ago

It not only adds a dependency to an external service but it adds it to one that is not an officially trusted service of pypi. This person tried to open a PR against a project I'm the maintainer for as well (https://github.com/ixmatus/inflector/pull/16). Users can get statistics from libraries.io which is linked to directly by pypi itself.