Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add workflow to see if code PRs also update documentation and/or add tests #3059

Closed
pnacht opened this issue May 24, 2023 · 2 comments
Labels
kind/docs Improvements or additions to documentation kind/enhancement New feature or request

Comments

@pnacht
Copy link
Contributor

pnacht commented May 24, 2023

Is your feature request related to a problem? Please describe.
PRs that modify Scorecard's behavior are occasionally merged without updating documentation. For example, the documentation for Token-Permissions currently doesn't reflect the changes from #2355 and #2367 from late 2022.

Describe the solution you'd like
An on: pull_request workflow that checks whether a given PR modified anything in the /checks folder. If so, the workflow only "passes" if the PR also modified the checks.yml and checks.md files and the respective test file. Alternatively, maintainers could add comments (or labels) to the PR such as /skip_docs_change or /skip_tests_change (or equivalent labels) to consciously and intentionally allow the PR to pass without such changes (which aren't always necessary).

Describe alternatives you've considered
Add [ ] Relevant changes to documentation have been made to the pull-request template. This would help contributors remember to update the documentation, but doesn't actually "enforce" anything. (Though this solution would be great too!)

Additional context
A pushback against this would be that it increases the workload for contributors who might want to make a useful contribution to Scorecard but don't want to update the docs. However, given the importance of up-to-date docs for a project such as Scorecard, maintainers could consider pushing their own commits to the PR with the relevant documentation changes before merging the PR.

@pnacht pnacht added the kind/enhancement New feature or request label May 24, 2023
@naveensrinivasan
Copy link
Member

This is a great suggestion! Thank you!
Would you like to lend a hand in tackling this?

@github-actions
Copy link

github-actions bot commented Sep 8, 2023

Stale issue message

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 16, 2023
@spencerschrock spencerschrock added the kind/docs Improvements or additions to documentation label Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs Improvements or additions to documentation kind/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants