Contributing to LibCST

We want to make contributing to this project as easy and transparent as possible.

Our Development Process

This github repo is the source of truth and all changes need to be reviewed in pull requests.

Pull Requests

We actively welcome your pull requests.

Setup Your Environment

Install a Rust toolchain and hatch
Fork the repo on your side
Clone the repo

git clone [your fork.git] libcst
cd libcst
Sync with the main libcst version package

git fetch --tags https://github.com/instagram/libcst
Setup the env

hatch env create

You are now ready to create your own branch from main, and contribute. Please provide tests (using unittest), and update the documentation (both docstrings and sphinx doc), if applicable.

Before Submitting Your Pull Request

Format your code

hatch run format
Run the type checker

hatch run typecheck
Test your changes

hatch run test
Check linters

hatch run lint

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.

Complete your CLA here: https://code.facebook.com/cla

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.

Coding Style

We use flake8 and ufmt to enforce coding style.

License

By contributing to LibCST, you agree that your contributions will be licensed under the MIT LICENSE file in the root directory of this source tree.

1.8 KiB Raw Blame History