🤝 Contributing Guide

This page is currently only available in Chinese. Please switch to 简体中文 for the full content.

🤝 Contributing Guide

We welcome all developers interested in python-office to contribute to the project! 🎉

Ways to Contribute

🐛 Report a Bug

Submit an issue on GitHub Issues with:

• A clear description of the problem
• Steps to reproduce
• Expected behavior vs actual behavior
• Environment info (OS, Python version, library version)

💡 Propose a New Feature

Discuss it in GitHub Discussions.

📝 Improve Documentation

• Fix typos
• Add usage examples
• Translate into other languages

💻 Submit Code

# 1. Fork the repository
# 2. Clone the code
git clone https://github.com/your-username/python-office.git
cd python-office

# 3. Create a branch
git checkout -b feature/your-feature-name

# 4. Install dev dependencies
python -m venv venv
source venv/bin/activate
pip install -e ".[dev]"

# 5. Commit your code
git add .
git commit -m "feat: add some feature"
git push origin feature/your-feature-name

# 6. Open a Pull Request

Development Conventions

Code Style

• Follow PEP 8
• Use Black to format

Commit Convention

Type	Description
feat	New feature
fix	Bug fix
docs	Documentation update
style	Code formatting
refactor	Refactor
test	Tests
chore	Build / tooling changes

Project Structure

python-office/
├── office/             # Main package
│   ├── __init__.py
│   ├── api/            # API layer
│   ├── core/
│   └── lib/            # Library layer
├── tests/
└── docs/

Contact Us

• 💬 Project Chat Group
• 📖 WeChat Official Account
• 🐙 GitHub

Thank you for your contribution! ❤️