Contributing

Thank you for your interest in contributing to TorchOptics!
We welcome contributions from the community to help improve the project.

Reporting bugs, asking questions, or suggesting features

If you encounter a bug, have a question, or would like to suggest a new feature, please open an issue on GitHub with a clear description.
Including screenshots, minimal code examples, or error logs is appreciated.

Development setup

To prepare your environment for development and testing:

1. Fork the repository on GitHub.
2. Clone your fork:

   git clone https://github.com/your-username/torchoptics.git
   cd torchoptics
   

3. Install TorchOptics in development mode:

   uv sync --all-extras
   

4. Install pre-commit hooks:

   pre-commit install
   

Pre-commit hooks will automatically run the following tools:

• ruff — for code formatting and linting
• pyright — for static type checking

Submitting a pull request

Submit your changes by opening a pull request from your fork.

1. Create a new branch:

   git checkout -b feature/your-feature-name
   

2. Make your changes and commit them.
3. Run the tests:

   pytest
   

4. Push your branch:

   git push origin feature/your-feature-name
   

5. Open a pull request against the main branch.
   Include a clear description and reference any related issues if applicable.

Editing the documentation

If you want to update the documentation, you can preview it locally before submitting a pull request.

1. Build the documentation:

   make -C docs html
   

2. Serve the documentation locally:

   python -m http.server 8000 --directory docs/build/html
   

Then open http://localhost:8000/ in your browser. Re-run the build command whenever you change the docs, and refresh the page to see the updates.