Skip to content

Latest commit

 

History

History
145 lines (94 loc) · 9.67 KB

CONTRIBUTING.md

File metadata and controls

145 lines (94 loc) · 9.67 KB

Contributing to the InstructLab CLI

👍🎉 First off, thank you for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. Please read the community contribution guide first for general practices for the 🐶 InstructLab community.

Important

InstructLab is a fast-paced project under rapid development. Please expect the codebase to undergo significant changes from release to release. If you don't have prior experience contributing to an early-stage open source project, you might want to consider contributing skills and knowledge to the model instead.

What Should I Know Before I Get Started?

Code of Conduct

This project adheres to the InstructLab - Code of Conduct and Covenant. By participating, you are expected to uphold this code.

How Do I Start Contributing?

The below workflow is designed to help you begin your first contribution journey. It will guide you through creating and picking up issues, working through them, having your work reviewed, and then merging.

Help on open source projects is always welcome and there is always something that can be improved. For example, documentation (like the text you are reading now) can always use improvement, code can always be clarified, variables or functions can always be renamed or commented on, and there is always a need for more test coverage. If you see something that you think should be fixed, take ownership! Here is how you get started:

How Can I Contribute?

When contributing, it's useful to start by looking at issues. After picking up an issue, writing code, or updating a document, make a pull request and your work will be reviewed and merged. If you're adding a new feature or find a bug, it's best to write an issue first to discuss it with maintainers.

To contribute to this repository, you'll use the Fork and Pull model common in many open source repositories. For details on this process, check out The GitHub Workflow Guide from Kubernetes.

When your contribution is ready, you can create a pull request. Pull requests are often referred to as "PR". In general, we follow the standard GitHub pull request process. Follow the template to provide details about your pull request to the maintainers.

Before sending pull requests, make sure your changes pass formatting, linting and unit tests.

Code Review

Once you've created a pull request, maintainers will review your code and may make suggestions to fix before merging. It will be easier for your pull request to receive reviews if you consider the criteria the reviewers follow while working. Remember to:

  • Run tests locally and ensure they pass
  • Follow the project coding conventions
  • Write detailed commit messages
  • Break large changes into a logical series of smaller patches, which are easy to understand individually and combine to solve a broader issue

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report ✏️, reproduce the behavior 💻, and find related reports 🔎.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues using the Bug Report template. Create an issue on that and provide the information suggested in the bug report issue template.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features, tools, and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion ✏️ and find related suggestions 🔎

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues using the Feature Request template. Create an issue and provide the information suggested in the feature requests or user story issue template.

How Do I Submit A (Good) Improvement Item?

Improvements to existing functionality are tracked as GitHub issues using the User Story template. Create an issue and provide the information suggested in the feature requests or user story issue template.

Development

Set up your dev environment

The following tools are required:

You can setup your dev environment using tox, an environment orchestrator which allows for setting up environments for and invoking builds, unit tests, formatting, linting, etc. Install tox with:

pip install -r requirements-dev.txt

Install project requirements with:

pip install -r requirements.txt

If you want to test the ilab binary, you can install ilab and all dependencies with:

pip install .[cpu]

Testing

Before pushing changes to GitHub, you need to run the tests as shown below. They can be run individually as shown in each sub-section or can be run with the one command (use -v for more detailed output):

tox

If you need to configure a proxy or a trusted host for pip while using tox, add the PIP_PROXY and PIP_TRUSTED_HOST environment variables in the setenv directive within the [testenv] section of tox.ini, for example:

[testenv]
setenv =
    PIP_PROXY = http://proxy.example.com:3128
    PIP_TRUSTED_HOST = pypi.org download.pytorch.org

Tools Overview

Purpose Tool name Description Example command
Unit tests pytest Runs unit tests for the project tox -e py3-unit
Functional tests Custom Functional Tests Script Executes functional tests defined in the project tox -e py3-functional
Code style ruff, black, isort Enforces pep8 coding style, checks for unused imports, complexity, and other code quality issues tox -e ruff
pylint pylint performs static code analysis tox -e lint
Type Checking mypy Performs static type analysis across the project to catch bugs tox -e mypy
Spell Checking pyspelling & aspell Checks for spelling errors in documentation and code comments tox -e spellcheck
Documentation Sphinx Generates HTML documentation for the project tox -e docs
TOML File Linting Custom Makefile process Lints and formats the pyproject.toml file tox -e tomllint

By default, all tests found within the tests directory are run. However, specific unit tests can run by passing filenames, classes and/or methods to pytest using tox positional arguments. The following example invokes a single test method test_diff_invalid_base within the TestLabDiff class that is declared in the tests/test_lab_diff.py file:

tox -e py3-unit -- tests/test_lab_diff.py:::TestLabDiff::test_diff_invalid_base

Additionally, tools like ruff, mypy, and lint can also be used with -- followed by a single file:

tox -e ruff -- code_file.py
tox -e mypy -- code_file.py
tox -e lint -- code_file.py

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through these issues:

  • Issues with the good first issue label - these should only require a few lines of code and are good targets if you're just starting contributing.
  • Issues with the help wanted label - these range from simple to more complex, but are generally things we want but can't get to in a short time frame.