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

Check files affected by task contribution Pull Requests #2644

Merged
merged 5 commits into from
Oct 26, 2024

Conversation

RafDevX
Copy link
Contributor

@RafDevX RafDevX commented Oct 12, 2024

Fixes #2583

This pull request checks whether any contributions match the norm of what is expected of a task proposal/submission:

  • exactly one file changed, named README.md and in a reasonable location; and
  • PR description matches the README file (so that reviewers don't need to check both places)

ludvigch and others added 3 commits October 12, 2024 20:00
This ensures that task contribution proposal/submission content is
identical in the pull request description and the affected README.md
file, so that reviewers can have confidence that they need only check
one of them without comparing against the other.
@RafDevX RafDevX marked this pull request as ready for review October 13, 2024 12:54
Copy link
Collaborator

@algomaster99 algomaster99 left a comment

Choose a reason for hiding this comment

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

Thank you so much! Sorry for the delay in review. Left some questions/comments.

.github/workflows/check_task.yml Show resolved Hide resolved
.github/workflows/check_task.yml Show resolved Hide resolved
@algomaster99
Copy link
Collaborator

@RafDevX @ludvigch could you please have a look at my comments?

@RafDevX
Copy link
Contributor Author

RafDevX commented Oct 22, 2024

Sorry, it's exam season - I'll take a look ASAP today or tomorrow.

@algomaster99
Copy link
Collaborator

No problem! Thanks for letting me know!

@algomaster99 algomaster99 self-assigned this Oct 22, 2024
Since we check that the PR description matches the affected README file,
we need to repeat this check if the description ever changes.

Note that the GitHub default for if no types are specified is "opened",
"reopened", and "synchronize" -- so this commit only adds "edited", in
practice.
Copy link
Collaborator

@algomaster99 algomaster99 left a comment

Choose a reason for hiding this comment

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

Looks good to me! Haven't tested it, but should work :)

@algomaster99 algomaster99 merged commit a3797aa into KTH:2024 Oct 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Break CI if there are more than 1 file changes
3 participants