How to Contribute to ProxTorch#

We’re glad you’re interested in contributing to ProxTorch! Whether you’re fixing bugs, adding new features, or updating documentation, your contributions are warmly welcome. Here’s how you can contribute:

Setting Up Your Environment#

  1. Fork the ProxTorch repository on GitHub.

  2. Clone your forked repository to your local machine.

  3. Set up a virtual environment: python -m venv venv

  4. Activate the virtual environment: source venv/bin/activate (on Linux/Mac) or .venvScriptsactivate (on Windows)

  5. Install the development dependencies: pip install -r requirements_dev.txt

Making Changes#

  1. Create a new branch for your changes: git checkout -b my-feature

  2. Make and commit your changes.

  3. Push the branch to your forked repository.

  4. Create a pull request from your branch to the main ProxTorch repository.

Documentation#

If you’re adding a new feature, remember to update the documentation accordingly. Ensure your changes are well-documented and follow the existing style and structure.

Tests#

Ensure that your changes do not break existing functionality by running unit tests. If you’re adding a new feature, include tests that cover this feature.

Pull Request Review#

Once your pull request is submitted, maintainers will review your changes. Please be patient as this can take some time. Address any feedback or changes requested by the maintainers.

Thanks for your interest in contributing to ProxTorch! Your efforts help make this project even better.