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 issue and PR templates #692

Merged
merged 4 commits into from
Jun 9, 2021

Conversation

s-weigand
Copy link
Member

Moved issue and PR templates to the proper folders and changed templates to differentiate better between different types of issues and PRs.

Ref:
GitHub communities docs

Testing

Passing the tests is mandatory.

Related issue
#608

@s-weigand s-weigand added the Type: Tooling Tools used for the project (CI, CD, docs etc.) label Jun 8, 2021
@s-weigand s-weigand requested a review from a team as a code owner June 8, 2021 15:56
@github-actions
Copy link
Contributor

github-actions bot commented Jun 8, 2021

Binder 👈 Launch a binder notebook on branch s-weigand/pyglotaran/issue-PR-templates

@s-weigand s-weigand requested a review from jsnel June 8, 2021 16:02
@s-weigand
Copy link
Member Author

If you want to try it out I temporarily changed the default branch of my fork to this branch and allowed issues. The assigning and label functionality might not work there though, since there are different labels and it isn't part of the glotaran orga.

@s-weigand s-weigand marked this pull request as draft June 8, 2021 16:24
@s-weigand
Copy link
Member Author

Hmm, the issue templates work fine, but the PR templates don't... need some investigating.

@s-weigand
Copy link
Member Author

s-weigand commented Jun 8, 2021

Ok sadly there isn't a nice UI selector for PR templates and there is for issue templates, but it was requested multiple times:

And was added to the requested feature list.

To use a specific PR template you need to add ?expand=1&template=<template_file_name> to the URL of your PR.
E.g.
https://github.com/s-weigand/pyglotaran/compare/issue-PR-templates...test-pr?expand=1&template=docs_PR.md

Also, It looks like the PR templates don't support the special template headers that issue templates support, they are supported via query parameters.

So until GitHub properly support multiple templates with easy usage we need a default template (.github/PULL_REQUEST_TEMPLATE.md)

The question now is, do we want to also keep custom templates and add a guide to the docs on how to use them (I at least would use them) or just delete them again?

@codecov
Copy link

codecov bot commented Jun 8, 2021

Codecov Report

Merging #692 (b396c56) into main (2c79861) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##            main    #692   +/-   ##
=====================================
  Coverage   81.7%   81.7%           
=====================================
  Files         79      79           
  Lines       3920    3920           
  Branches     693     693           
=====================================
  Hits        3206    3206           
  Misses       594     594           
  Partials     120     120           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2c79861...b396c56. Read the comment docs.

@s-weigand s-weigand force-pushed the issue-PR-templates branch from c5d67ac to 8a4055e Compare June 8, 2021 18:14
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 8, 2021

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@s-weigand
Copy link
Member Author

Custom PR template usage

And here are some test PRs with the template:

@s-weigand s-weigand marked this pull request as ready for review June 8, 2021 20:51
Copy link
Member

@jsnel jsnel left a comment

Choose a reason for hiding this comment

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

Very nice. Thanks.

@jsnel jsnel merged commit cc168ae into glotaran:main Jun 9, 2021
@s-weigand s-weigand deleted the issue-PR-templates branch June 12, 2021 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Tooling Tools used for the project (CI, CD, docs etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants