omni-us / jsonargparse

Implement minimal boilerplate CLIs derived from type hints and parse from command line, config files and environment variables
https://jsonargparse.readthedocs.io
MIT License
314 stars 42 forks source link

Improvements to CONTRIBUTING.rst #472

Closed mauvilsa closed 5 months ago

mauvilsa commented 5 months ago

Before submitting

sonarcloud[bot] commented 5 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

codecov[bot] commented 5 months ago

Codecov Report

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

Project coverage is 100.00%. Comparing base (7a4a3dc) to head (c52d363).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #472 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 21 21 Lines 6005 6005 ========================================= Hits 6005 6005 ``` | [Flag](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | Coverage Δ | | |---|---|---| | [py3.10](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.39% <ø> (ø)` | | | [py3.10_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <ø> (ø)` | | | [py3.10_pydantic1](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `48.94% <ø> (ø)` | | | [py3.10_pydantic2](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `48.67% <ø> (ø)` | | | [py3.10_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <ø> (ø)` | | | [py3.11](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.37% <ø> (ø)` | | | [py3.11_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <ø> (ø)` | | | [py3.11_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <ø> (ø)` | | | [py3.12](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.37% <ø> (ø)` | | | [py3.12_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <ø> (ø)` | | | [py3.12_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <ø> (ø)` | | | [py3.7](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.95% <ø> (ø)` | | | [py3.7_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.49% <ø> (ø)` | | | [py3.7_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.47% <ø> (ø)` | | | [py3.8](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `89.10% <ø> (ø)` | | | [py3.8_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.51% <ø> (ø)` | | | [py3.8_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.50% <ø> (ø)` | | | [py3.9](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.95% <ø> (ø)` | | | [py3.9_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.38% <ø> (ø)` | | | [py3.9_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/472/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.38% <ø> (ø)` | | 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=omni-us#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.