Skip to main content

Contributing to clusterscope

We welcome contributions in the form of questions, issues and feature-requests, and pull requests in Github.

Development Workflow​

Environment setup​

Running the below from the root of the repository brings uv, all required development dependencies, and installs clusterscope in editable mode:

make install-dev-requirements

You can then activate the env:

source <(make activate)

This should get you started with a binary and library available in your local environment:

$ python
>>> import clusterscope
>>> clusterscope.cluster()
'<your-cluster-name>'
$ cscope
usage: cscope [-h] {info,cpus,gpus,check-gpu,aws} ...
...

pre-commit​

We have all linters/formatters/typecheckers integrated into pre-commit, these checks are also running as part of github CI. pre-commit automates part of the changes that will be required to land code on the repo. You can run the below to activate pre-commit in your local env:

pre-commit install

Requirements​

If you update the requirements, make sure to add it to pyproject.toml's appropriate section for the dependency. Then you can run the below to update the requirements file:

$ make requirements.txt

For development dependencies:

$ make dev-requirements.txt

Pull Requests​

We welcome your pull requests.

  1. Fork the repo and create your feature branch from main.
  2. If you've added code add suitable tests.
  3. Ensure the test suite and lint pass.
  4. If you haven't already, complete the Contributor License Agreement ("CLA").

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

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.

License​

By contributing to clusterscope, you agree that your contributions will be licensed under the LICENSE file in Github.