propelorm / Propel2

Propel2 is an open-source high-performance Object-Relational Mapping (ORM) for modern PHP
http://propelorm.org/
MIT License
1.26k stars 393 forks source link

Update README: add link to test documentation #1934

Closed mringler closed 1 year ago

mringler commented 1 year ago

Updated the "Contribute" segment of the README to feature the link to the test documentation more prominently. Knowing how to run tests locally is very important for new contributors, I think it makes sense to link to the page directly.

There is also a link to a roadmap, but the page has not been updated in 2.5 years. Should we remove that link?

codecov-commenter commented 1 year ago

Codecov Report

Base: 73.25% // Head: 88.28% // Increases project coverage by +15.03% :tada:

Coverage data is based on head (44f0487) compared to base (b542279). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1934 +/- ## ============================================= + Coverage 73.25% 88.28% +15.03% - Complexity 7917 7951 +34 ============================================= Files 227 242 +15 Lines 21133 24211 +3078 ============================================= + Hits 15480 21375 +5895 + Misses 5653 2836 -2817 ``` | Flag | Coverage Δ | | |---|---|---| | 5-max | `88.28% <ø> (+15.03%)` | :arrow_up: | | 7.4 | `88.28% <ø> (+15.03%)` | :arrow_up: | | agnostic | `67.59% <ø> (?)` | | | mysql | `68.98% <ø> (+0.03%)` | :arrow_up: | | pgsql | `68.99% <ø> (-0.06%)` | :arrow_down: | | sqlite | `66.94% <ø> (-0.02%)` | :arrow_down: | 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=propelorm#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/propelorm/Propel2/pull/1934?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm) | Coverage Δ | | |---|---|---| | [src/Propel/Generator/Builder/Om/ClassTools.php](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm#diff-c3JjL1Byb3BlbC9HZW5lcmF0b3IvQnVpbGRlci9PbS9DbGFzc1Rvb2xzLnBocA==) | `45.94% <0.00%> (-16.56%)` | :arrow_down: | | [...el/Generator/Builder/Om/ExtensionObjectBuilder.php](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm#diff-c3JjL1Byb3BlbC9HZW5lcmF0b3IvQnVpbGRlci9PbS9FeHRlbnNpb25PYmplY3RCdWlsZGVyLnBocA==) | `81.48% <0.00%> (-7.41%)` | :arrow_down: | | [src/Propel/Generator/Model/BehaviorableTrait.php](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm#diff-c3JjL1Byb3BlbC9HZW5lcmF0b3IvTW9kZWwvQmVoYXZpb3JhYmxlVHJhaXQucGhw) | `76.92% <0.00%> (-5.94%)` | :arrow_down: | | [...or/Builder/Om/ExtensionQueryInheritanceBuilder.php](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm#diff-c3JjL1Byb3BlbC9HZW5lcmF0b3IvQnVpbGRlci9PbS9FeHRlbnNpb25RdWVyeUluaGVyaXRhbmNlQnVpbGRlci5waHA=) | `83.33% <0.00%> (-5.13%)` | :arrow_down: | | [...l/Generator/Behavior/Validate/ValidateBehavior.php](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm#diff-c3JjL1Byb3BlbC9HZW5lcmF0b3IvQmVoYXZpb3IvVmFsaWRhdGUvVmFsaWRhdGVCZWhhdmlvci5waHA=) | `91.80% <0.00%> (-4.12%)` | :arrow_down: | | [.../Propel/Generator/Command/Helper/ConsoleHelper.php](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm#diff-c3JjL1Byb3BlbC9HZW5lcmF0b3IvQ29tbWFuZC9IZWxwZXIvQ29uc29sZUhlbHBlci5waHA=) | `80.76% <0.00%> (-4.02%)` | :arrow_down: | | [.../Propel/Generator/Command/MigrationDiffCommand.php](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm#diff-c3JjL1Byb3BlbC9HZW5lcmF0b3IvQ29tbWFuZC9NaWdyYXRpb25EaWZmQ29tbWFuZC5waHA=) | `79.54% <0.00%> (-3.66%)` | :arrow_down: | | [.../Generator/Builder/Om/MultiExtendObjectBuilder.php](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm#diff-c3JjL1Byb3BlbC9HZW5lcmF0b3IvQnVpbGRlci9PbS9NdWx0aUV4dGVuZE9iamVjdEJ1aWxkZXIucGhw) | `85.71% <0.00%> (-2.66%)` | :arrow_down: | | [...l/Generator/Behavior/Sortable/SortableBehavior.php](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm#diff-c3JjL1Byb3BlbC9HZW5lcmF0b3IvQmVoYXZpb3IvU29ydGFibGUvU29ydGFibGVCZWhhdmlvci5waHA=) | `94.87% <0.00%> (-2.36%)` | :arrow_down: | | [src/Propel/Runtime/ActiveQuery/ModelJoin.php](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm#diff-c3JjL1Byb3BlbC9SdW50aW1lL0FjdGl2ZVF1ZXJ5L01vZGVsSm9pbi5waHA=) | `65.38% <0.00%> (-2.23%)` | :arrow_down: | | ... and [186 more](https://codecov.io/gh/propelorm/Propel2/pull/1934/diff?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm) | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=propelorm)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

dereuromark commented 1 year ago

Yeah probably should