KEMBAR78
:book: Updated CI-Test description by Jordin221 · Pull Request #4275 · ossf/scorecard · GitHub
Skip to content

Conversation

@Jordin221
Copy link
Contributor

Modified description to detail test only considers successes.

What kind of change does this PR introduce?

Updated documentation of CI-Test check description to highlight it only considers successes.

What is the current behavior?

Description does not mention that this check only considers successes.

What is the new behavior (if this is a feature change)?**

The description now mentions that the check only considers successes.

  • Tests for the changes have been added (for bug fixes/features)

Which issue(s) this PR fixes

Fixes #3616

Special notes for your reviewer

Does this PR introduce a user-facing change?

For user-facing changes, please add a concise, human-readable release note to
the release-note

(In particular, describe what changes users might need to make in their
application as a result of this pull request.)

NONE

Modified description to detail test only considers successes.

Co-authored-by: Silas Morgan <victorsmorgan@gmail.com> 
Co-authored-by: Kemon Bynum <kemonbynum18@gmail.com>


Signed-off-by: Jordin <j.a.jones107732@spartans.nsu.edu>
Copy link
Member

@spencerschrock spencerschrock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution, please see the provided feedback.

Comment on lines +144 to +146
support other source hosting repositories (i.e., Forges). This check only considers
and rewards repositories that do run test. Repositories, however, will not be penalized
if they do not run test before pull requests.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this reflects the clarification #3616 was trying to make. I believe the distinction was that tests can pass or fail, and Scorecard only considers tests that succeed/pass, not that there are tests present.

Repositories, however, will not be penalized if they do not run test before pull requests.

Repositories are penalized if they don't run tests, so this addition should be removed.

Also please see the CONTRIBUTING.md for instructions on how to modify this file
https://github.com/ossf/scorecard/blob/main/CONTRIBUTING.md#updating-docs

@Jordin221 Jordin221 closed this by deleting the head repository Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

CITest evaluation documentation inconsistent with implementation

2 participants