oamg / convert2rhel

A tool to automate converting Oracle/CentOS/Scientific/Rocky/Alma Linux to Red Hat Enterprise Linux
GNU General Public License v3.0
103 stars 82 forks source link

chore: include type comments recommendation #1293

Open Venefilyn opened 3 weeks ago

Venefilyn commented 3 weeks ago

This adds the type comments section from the type hints PEP as a recommendation within the CONTRIBUTING.md. In particular this will help us with IDE and editor suggestions and warnings

https://peps.python.org/pep-0484/#type-comments

Jira Issues:

-

Checklist

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.84%. Comparing base (81c59f6) to head (f75c757).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1293 +/- ## ======================================= Coverage 95.84% 95.84% ======================================= Files 55 55 Lines 4771 4771 Branches 840 840 ======================================= Hits 4573 4573 Misses 112 112 Partials 86 86 ``` | [Flag](https://app.codecov.io/gh/oamg/convert2rhel/pull/1293/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=oamg) | Coverage Δ | | |---|---|---| | [centos-linux-7](https://app.codecov.io/gh/oamg/convert2rhel/pull/1293/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=oamg) | `91.05% <ø> (ø)` | | | [centos-linux-8](https://app.codecov.io/gh/oamg/convert2rhel/pull/1293/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=oamg) | `91.98% <ø> (ø)` | | | [centos-linux-9](https://app.codecov.io/gh/oamg/convert2rhel/pull/1293/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=oamg) | `92.02% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=oamg#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

has-bot commented 3 weeks ago

This PR does not require integration tests to be run.


Comment generated by an automation.

Log | Bot Usage