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

Update pull_request_template.md #3446

Merged
merged 2 commits into from Mar 22, 2024
Merged

Conversation

mattulbrich
Copy link
Member

Intended Change

Updated and improved the pull request template.

Removing the checkboxes which always (if unticked) indicated that the PR is only partially finished in the overview. Replaced by item list from which items can be deleted.

Refining the structure. Adding a new subsection "Plan".

Type of pull request

  • There are changes to the deployment/CI infrastructure (gradle, github, ...)

Ensuring quality

n/a

Additional information and contact(s)

The contributions within this pull request are licensed under GPLv2 (only) for inclusion in KeY.

Removing the checkboxes which always (if unticked) indicated that the PR is only partially finished in the overview. Replaced by item list from which items can be deleted.

Refining the structure. Adding a new subsection "Plan".
Copy link

codecov bot commented Mar 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.85%. Comparing base (fb58c33) to head (bac61ee).

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #3446      +/-   ##
============================================
- Coverage     37.85%   37.85%   -0.01%     
  Complexity    17042    17042              
============================================
  Files          2082     2082              
  Lines        127290   127290              
  Branches      21441    21441              
============================================
- Hits          48184    48183       -1     
  Misses        73194    73194              
- Partials       5912     5913       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wadoon
Copy link
Member

wadoon commented Mar 22, 2024

Can we get rid of the not semantically-correctly used todo items?

  • Yes
  • No
  • Maybe?

I find it very annoying if you look on a PR and Github says "5 out of 10 tasks done".

@WolframPfeifer
Copy link
Member

Can we get rid of the not semantically-correctly used todo items?

* [ ]  Yes

* [ ]  No

* [ ]  Maybe?

I find it very annoying if you look on a PR and Github says "5 out of 10 tasks done".

Is this not exactly what the PR does?

Copy link
Member

@WolframPfeifer WolframPfeifer left a comment

Choose a reason for hiding this comment

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

Thanks, I also find this very annoying. Unfortunately, checkboxes that are not task lists are not really supported by GitHub at the moment, even though this feature that was requested multiple times. One of these feature requests also mentioned a workaround: You can wrap checkboxes in a list, then they are not counted as tasks:

    • option 1
    • option 2
    • option 3
      While this may mess up the spacing a bit (conceptually, this is a list of lists then), we could also use this. However, I am also quite happy with the template suggested in this PR.

@mattulbrich
Copy link
Member Author

I find it very annoying if you look on a PR and Github says "5 out of 10 tasks done".

That's the reason for the PR. If we have checkboxes than we should have them for things were 10/10 is the desired goal, and fewer should not be merged.

@mattulbrich mattulbrich added this pull request to the merge queue Mar 22, 2024
Merged via the queue into main with commit a5b90ec Mar 22, 2024
14 checks passed
@mattulbrich mattulbrich deleted the mu-pull-request-refinement branch March 22, 2024 16:38
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.

None yet

3 participants