Release FAQs

If you've followed the steps listed in Defining your metric and Development then the SDV team can guide you through the remaining process of adding your metric.
In the meantime, use the tabs below to explore some Frequently Asked Questions related to releasing your metric.
The CLAassistant is an automated bot that comments on pull requests. If this is your first time contributing code to SDMetrics, the assistant will ask you to sign a Contributor License Agreement (CLA) in order to proceed. We are unable to accept your contribution until you sign the CLA.
Once your pull request is accepted, the new functionality you're adding is merged into the main working branch on GitHub.
Every few weeks, a member of the core SDV team will perform a new SDMetrics library release by bumping the version and merging the main branch into stable. During this process, new versions of the software are published to PyPi and Conda. The new versions will include your functionality!
Your GitHub issue will be marked as closed whenever the associated pull request is accepted and merged. This indicates that the code will be available in the next software release.
If your issue has remained open even after the functionality has already been released, please feel free to manually close it.
An open source maintainer will update the docs to include your metric after it is available in a new software release. The SDV team will generate the description and API based on your initial GitHub issue.
Note that your metric may initially show up in the Beta section, especially if it includes new concepts that have not yet been validated by the community or if there is uncertainty about how to interpret the metric. Reach out to the SDV team via GitHub to create a plan for bumping it up to the main glossary.
Your metric may appear in a new or existing report. However, we not currently have an external contribution process for the reports.
If you'd like us to consider your metric for a specific report, please file a GitHub feature request and we'll get back to you as soon as we can.