Giters

jenkins-infra / plugin-health-scoring

This project aims to introduce a metric system to calculate the health score of each plugin within the Jenkins ecosystem and reflect the final scores on the Plugin Site for the plugin maintainers and users.

Home Page:https://plugin-health.jenkins.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Probe to detect whether the pull_request_template.md is present in the plugins.

AayushSaini101 opened this issue · comments

commented

Description

Probe to detect whether the pull_request_template.md is present in the plugins.

Benefits:

  • Help the contributors understand the prerequisite for the particular plugin
  • Help identify the area that needs to be updated while making PR on the plugin.
commented

To be fair, the pull request template is not enforcing anything. See, even on this project, some pull request authors removes most of the template when they probably shouldn't.
The most important thing in my opinion is the contributing guide, which is by default inherited from the jenkinsci/.github repository.

That repository already have a pull request template but I cannot find documentation if it's inherited or not in the repository of the organization.

commented

To be fair, the pull request template is not enforcing anything. See, even on this project, some pull request authors removes most of the template when they probably shouldn't. The most important thing in my opinion is the contributing guide, which is by default inherited from the jenkinsci/.github repository.

That repository already have a pull request template but I cannot find documentation if it's inherited or not in the repository of the organization.

Thanks for your opinion, but ideally case it helps the new contributors as well as maintainers suppose they are making the changes and the repository has no template and the maintainer merged the changes [ that might be possible], without proper additional test cases.
If the template contains the check the feat: changes must require test cases, then it automatically helps the maintainers to check whether the PR contains the test cases or not.

" some pull request authors removes most of the template when they probably shouldn't." we can improve this by using probe. It helps the stability of the plugins

commented

ideally case it helps the new contributors

true, but they can dismiss it. That's why the template is not part of the plugin modernization.

the maintainer merged the changes [ that might be possible], without proper additional test cases.

if the template mentions testing, the maintainer won't forget about it. If it does, the contributors can still choose to delete part of the pull request content when creating it.

the maintainer merged the changes [ that might be possible], without proper additional test cases.

a probe won't help at all. As I said, a repository can have a pull request template, but we would have to check every pull request and we would be impacting bad contributors behaviour onto the plugin score. This is definitively not the way the project should go.