Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (41 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

55 lines (41 loc) · 1.12 KB

Contributing to PyTenNet

Thanks for your interest! Here's how to contribute.

Quick Start

git clone https://github.com/tigantic/PyTenNet.git
cd PyTenNet
pip install torch pytest
python -m pytest  # Run tests

Ways to Contribute

🐛 Bug Reports

Open an issue with:

  • What you expected vs what happened
  • Minimal code to reproduce
  • Your environment (Python, PyTorch, OS)

💡 Feature Requests

Open an issue describing:

  • The problem you're solving
  • Your proposed solution
  • Alternatives you considered

🔧 Pull Requests

  1. Fork the repo
  2. Create a branch: git checkout -b feature/your-feature
  3. Make changes
  4. Run tests: python reproduce.py
  5. Commit: git commit -m "feat: add your feature"
  6. Push and open a PR

Code Style

  • Use descriptive variable names
  • Add docstrings to functions
  • Keep functions focused and small
  • Follow existing patterns in the codebase

Commit Messages

Use conventional commits:

  • feat: new feature
  • fix: bug fix
  • docs: documentation
  • test: adding tests
  • refactor: code restructuring

Questions?

Open an issue or discussion. We're happy to help!