Skip to content

docs: Add CONTRIBUTING.md#314

Open
yurekami wants to merge 17 commits intomit-han-lab:devfrom
yurekami:docs/issue-294-contributing-md
Open

docs: Add CONTRIBUTING.md#314
yurekami wants to merge 17 commits intomit-han-lab:devfrom
yurekami:docs/issue-294-contributing-md

Conversation

@yurekami
Copy link

Summary

Closes #294

This PR adds a comprehensive CONTRIBUTING.md file to help new contributors understand how to contribute to TorchQuantum.

Contents

The guide includes:

  • Development Environment Setup: How to fork, clone, and install in dev mode
  • Branch Strategy: Explains that PRs should target dev branch, not main
  • Pull Request Process: Step-by-step instructions for creating PRs
  • Code Style Guidelines: PEP 8, docstrings, type hints
  • Testing Requirements: All changes must pass tests, new features need tests
  • Types of Contributions: Bug fixes, new features, documentation

Checklist

  • Follows repository conventions
  • Includes branch strategy info (PRs to dev)
  • Includes testing requirements
  • Includes maintainer ping instruction

🤖 Generated with Claude Code

zkysfls and others added 17 commits February 21, 2025 12:45
This reverts commit 477d356.
Fix typo in README.md
Closes mit-han-lab#294

This adds a comprehensive contributing guide that includes:
- Development environment setup instructions
- Branch strategy (PRs should target dev branch)
- Pull request process
- Code style guidelines
- Testing requirements
- Types of contributions welcome

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants