Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

30 lines (18 loc) · 1.63 KB
Raw

Contributing to the AIF360 R package

This guide is divided into three main parts:

  1. Filing a bug report or feature request in an issue.
  2. Suggesting a change via a pull request.
  3. New features or enhancements to AIF360 functionality.

If you're not familiar with git or GitHub, please start by reading http://r-pkgs.had.co.nz/git.html

Please note that the AIF360 R package is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Issues

If you find a bug, please search GitHub under Issues to ensure the bug was not already reported. If you’re unable to find an open issue addressing the problem, open a new one. Please include a title and clear description, as much relevant information as possible (such as required packages, data, etc.), and a code sample to replicate the issue.

Pull requests

To contribute a change to the AIF360 R package, you follow these steps:

  • Create a branch in git and make your changes.
  • Push branch to GitHub and open a new pull request (PR).
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

New Features

The AIF360 R package is part of AI Fairness 360, developed with extensibility in mind. If you wish to suggest new metrics, explainers, algorithms or datasets. Please get in touch on Slack (invitation here)!