search

todogroup / repolinter

Repolinter, The Open Source Repository Linter
https://todogroup.github.io/repolinter/
Apache License 2.0
421 stars 72 forks source link

feat: update github pull request template locations #326

Closed scottschreckengaust closed 2 months ago

scottschreckengaust commented 2 months ago

Include GitHub documented locations for pull request templates.

Motivation

Fixes: https://github.com/todogroup/repolinter/issues/321 GitHub documents other locations for a pull request template.

Proposed Changes

Update the list of pull request template locations to match the documentation.

Test Plan

Run the code on various repositories with additional locations.

scottschreckengaust commented 2 months ago

Tested via GitHub workflow: https://github.com/scottschreckengaust/repolinter-tester/actions/runs/10049150744

...
2024-07-22T22:13:44.6859788Z ✔ github-pull-request-template-exists: Found file (.github/pull_request_template.md)
...
hyandell commented 2 months ago

Brilliant - thank you Scott.

Reading the https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository page - it feels like it also says "You can also store multiple pull request templates in a PULL_REQUEST_TEMPLATE subdirectory within the root or docs/ directories"

So, would you say "docs/PULL_REQUEST_TEMPLATE*" should also be added?