Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (36 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 2.25 KB

Contributing Guide

Thank you for your interest in contributing to DeepLens!

All contributors are expected to follow our Code of Conduct.

Contributor License Agreement (CLA)

All pull requests to the DeepLens project require contributors to sign a Contributor License Agreement (CLA). This process is automated through CLA Assistant, which will prompt you to sign the CLA when you submit your first pull request. You can review the DeepLens-CLA.

How to Contribute

We welcome contributions in various forms, including but not limited to:

  • Reporting bugs
  • Submitting pull requests with bug fixes or new features
  • Improving documentation
  • Adding new examples or tutorials

If you plan to work on a major feature, please open an issue to discuss your ideas with the maintainers first.

Developer Installation

DeepLens is primarily a Pytorch project. To set up your development environment, please follow the "How to use" section in the README.md to create a conda environment and install the necessary dependencies.

A quick summary of the steps:

# Create and activate a conda environment
conda env create -f environment.yml -n deeplens_env
conda activate deeplens_env

or

conda create --name deeplens_env python=3.9
conda activate deeplens_env
pip install -r requirements.txt

Code Formatting

We encourage contributors to format their code with ruff to maintain consistent code style across the project. You can install ruff and format your code with:

pip install ruff
ruff format .

Contribution Opportunities

A great place to start looking for contribution ideas is the project's issue tracker on GitHub. You can check out the open questions project board mentioned in the README.

Proposing Major Changes

For substantial changes to the codebase, it is a good idea to open an issue to propose your change. This allows for discussion with the maintainers and community before you invest significant time in implementation. This helps ensure your contribution aligns with the project's goals and is more likely to be accepted.