How to contribute

Do you want to suggest a new metric?

We'd love to hear what you think makes good metrics - we're taking suggestions through the GitHub issues system.
To suggest a new metric:
1. Check the metric has not been suggested / implemented already by searching on GitHub under Issues with the label "metric"
2. If it's not there, open a new issue. Be sure to include a title and clear description of your metric, with as much relevant information as possible, for instance what category of metric it is, links to background references / material, and a description of what the metric measures. Make sure you apply the "Metric" label to the issue.

Ensure the bug was not already reported by searching on GitHub under Issues.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Open a new GitHub pull request with the patch.
Ensure the pull request description clearly describes the problem and solution. Include the relevant issue number if applicable.

We're particularly keen to extend the range of software metrics on offer - take a look at existing set and extend the Base Metric class
You could also extend the range of Repository Helper plugins to support new code repositories.
Create a new issue suggesting your change. On your issue, please include a reproducible case that we can actually run.
After you have collected some positive feedback about the change you should start writing code and when your code is ready submit a pull request.

Thanks!

The Software Sustainability Institute Team