Skip to content

docs: add CONTRIBUTING.md with community guidelines#6

Open
zichen0116 wants to merge 1 commit into
TencentARC:masterfrom
zichen0116:add-contributing-guide
Open

docs: add CONTRIBUTING.md with community guidelines#6
zichen0116 wants to merge 1 commit into
TencentARC:masterfrom
zichen0116:add-contributing-guide

Conversation

@zichen0116

Copy link
Copy Markdown

Summary

This PR adds a comprehensive CONTRIBUTING.md to help new contributors get started with Pixal3D.

What's included

  • Issue reporting best practices (search duplicates, provide environment details)
  • Pull request workflow with clear branch naming and conventional commits
  • Code style guidelines (PEP 8, docstrings, modular design)
  • Pre-commit checklist (linting, type checking, testing)
  • Documentation expectations for user-facing changes
  • Development setup with minimal commands to get running
  • License attribution clarifying contributions fall under MIT

Why this matters

As Pixal3D gains traction in the 3D generation community, a well-written contributing guide reduces friction for newcomers, standardizes submission quality, and scales maintainers' review capacity.

Checklist

  • Content adapted from proven community templates
  • Instructions match the current master branch setup
  • Compatible with the existing MIT license

Looking forward to helping more researchers and engineers contribute to this excellent SIGGRAPH 2026 work! 🚀

Add comprehensive contribution guidelines covering:
- Issue reporting best practices
- Pull request workflow and commit conventions
- Code style recommendations (PEP 8)
- Pre-commit verification checklist
- Development setup instructions
- License attribution notice
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.

1 participant