Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 1.96 KB
Raw

Contributing to Autolabel

Welcome, and thank you for your interest in contributing to Autolabel! We welcome contributions in all forms - bug reports, pull requests and ideas for improving the library.

  1. For proposing new feature ideas or sharing your feedback, you can join our Discord to chat with the community.
  2. For submitting a bug report or improvement to the documentation, you can open an issue on Github.
  3. For contributing code, please read the code contribution guidelines below. Open issues tagged with good-first-issue are good candidates if you'd like to start contributing to the repository!

Setting Up Your Environment

  1. Clone the repository:
git clone https://github.com/refuel-ai/autolabel.git
  1. Go to the project home directory:
cd autolabel
  1. Install the library from source (preferably in a virtual environment):
pip install '.[dev]'
  1. Install pre-commit and then run:
pre-commit install
  1. If the following code snippet does not return any error, the installation is successful:
python -c "from autolabel import LabelingAgent"

Here is a quick video that walks through the steps:

autolabel_install_fresh_virtual_env.mov

Code contribution guidelines

Please follow a "fork and pull request" workflow for submitting changes to the repository.

Github issue guidelines

To open a new issue, go to the issues page.

  • We have a taxonomy of labels to help organize and catalog reported issues. Please use these as much as possible to help sort issues efficiently.
  • If you are adding an issue, please try to follow one of the provided templates.