search

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.
https://plugin-health.jenkins.io
MIT License
24 stars 46 forks source link

Documentation scoring should probably not consider "contributing guidelines" inheritance as an issue #487

Closed PierreBtz closed 8 months ago

PierreBtz commented 8 months ago

Description of the bug

Currently, inheriting from the global contributing guidelines of the jenkinsci organization is considered an issue reducing the documentation score of a plugin. See for instance this plugin:

Screenshot 2024-03-15 at 16 12 45

There are several issues with this approach:

  1. it can be easily cheesed by simply adding contributions guideline that are linking back (or worst that are a copy) of the org ones.
  2. contribution guideline should ideally be the same for each plugin, an incentive to override this per repository goes against this.
alecharp commented 8 months ago

While I agree that losing points over this when the global contributing guide is valid for the vast majority of the plugins is a shame.

contribution guideline should ideally be the same for each plugin, an incentive to override this per repository goes against this.

I would argue that some plugins have specific requirements (UI, API plugins) which would be nice to see in a specific contributing guide.

We could fix the situation with:

  1. using global contributing guide is fine (no point lost)
  2. have a specific one is better (extra credit?)
  3. empty contributing guide is bad.

Does this make sense to you?

PierreBtz commented 8 months ago

Looks good!