Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jul 24, 2025

This PR adds a comprehensive CONTRIBUTING.md file to the repository root to standardize and streamline contributions from the community and coding copilots.

What's Added

The CONTRIBUTING.md file includes the following sections:

  • Getting Started: Prerequisites (Node.js v18.16.1+, Rust v1.70.0+), platform-specific tools, and initial setup instructions
  • Development Workflow: Step-by-step guide for forking, cloning, branching, and creating pull requests
  • Coding Standards: References to existing style guides for all supported languages:
    • TypeScript (Google TypeScript Style Guide)
    • Rust (Rustfmt Style Guide)
    • C/C++ (Google C++ Style Guide)
    • C# (Microsoft C# Style Guide)
    • ShaderLab (Unity ShaderLab Style Guide)
  • Building and Testing: Platform-specific build commands (make darwin, make android, make windows) with available options
  • Commit Message Conventions: Conventional commit format with examples
  • Pull Request Process: Guidelines for submitting and reviewing PRs
  • Code of Conduct: Community guidelines for respectful collaboration
  • License: Apache 2.0 license reference
  • Additional Resources: Links to documentation, API references, and help resources

Benefits

This will help:

  • New contributors get started quickly with clear setup instructions
  • Maintain consistent code quality across the multi-language codebase
  • Standardize the contribution workflow and PR process
  • Improve collaboration between human contributors and AI coding assistants
  • Reduce maintainer overhead by providing self-service documentation

The file references existing documentation in docs/contributing/ and follows GitHub's best practices for CONTRIBUTING.md files.

Fixes #137.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • registry.npmmirror.com
    • Triggering command: npm install (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: yorkie <1935767+yorkie@users.noreply.github.com>
Copilot AI changed the title [WIP] Add CONTRIBUTING.md to guide contributors and copilot Add CONTRIBUTING.md to guide contributors and copilot Jul 24, 2025
Copilot AI requested a review from yorkie July 24, 2025 09:16
Copy link
Collaborator

@yorkie yorkie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a note to the related coding style: using 2 spaces as the default source indents.

Add explicit note about using 2 spaces for indentation across all source files in the Code Formatting section of CONTRIBUTING.md

Co-authored-by: yorkie <1935767+yorkie@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jul 24, 2025

Please add a note to the related coding style: using 2 spaces as the default source indents.

Added explicit note about 2-space indentation standard to the Code Formatting section. The note references how this is enforced by the automated formatting tools and configured in the project's formatting configuration files (e0d209b).

Copilot AI requested a review from yorkie July 24, 2025 09:26
@yorkie yorkie marked this pull request as ready for review July 24, 2025 10:30
@yorkie yorkie merged commit 0f5a7bf into main Jul 24, 2025
2 checks passed
@yorkie yorkie deleted the copilot/fix-137 branch July 24, 2025 10:33
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.

Add CONTRIBUTING.md to guide contributors and copilot

2 participants