Skip to content

Update CONTRIBUTING.md #1142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 12, 2024
Merged

Update CONTRIBUTING.md #1142

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d331e2
Update CONTRIBUTING.md
zaicruvoir1rominet May 10, 2024
7a1e5e7
Fix repo link
zaicruvoir1rominet May 11, 2024
8b275cd
Fix line break getting removed
zaicruvoir1rominet May 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 24 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,30 @@ pull requests.
## Pull Requests
We actively welcome your pull requests.

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes by `python -m unittest`.
5. Make sure your code lints.
6. If you haven't already, complete the Contributor License Agreement ("CLA").
### Setup Your Environment

1. Install a [Rust toolchain](https://rustup.rs) and [hatch](https://hatch.pypa.io)
2. Fork the repo on your side
3. Clone the repo
> git clone [your fork.git] libcst
> cd libcst
4. Sync with the main libcst version package
> git fetch --tags https://github.com/instagram/libcst
5. 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

1. Format your code
> hatch run format
2. Test your changes
> hatch run test
3. 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
Expand Down