Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (74 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

93 lines (74 loc) · 3.1 KB

Contributing to Community-Library

Thank you for your interest in contributing to the Community-Library! This repository is a collaborative effort to build a comprehensive collection of metaverse development resources across multiple platforms.

How to Contribute

1. Fork and Clone

  • Fork this repository to your GitHub account
  • Clone your fork locally
  • Create a new branch for your contribution

2. Choose Your Platform

Navigate to the appropriate platform directory:

  • /Unity - Unity 3D projects and assets
  • /Spatial - Spatial.io content
  • /UnrealEngine - Unreal Engine projects
  • /Roblox - Roblox experiences and scripts
  • /SecondLife - Second Life content
  • /Decentraland - Decentraland scenes and assets
  • /OtherPlatforms - Emerging or less common platforms

3. Organize Your Content

Place your contributions in the appropriate subdirectory:

Assets

  • 3DModels: .fbx, .obj, .blend files
  • Textures: .png, .jpg, .tga files
  • Audio: .wav, .mp3 files
  • MaterialsShaders: Material definitions and shader files
  • Animations: Animation files and sequences

Lessons

  • Tutorials: Step-by-step guides with clear instructions
  • Documentation: Concept explanations and technical documentation
  • BestPractices: Recommended approaches and methodologies

SourceCode

  • Scripts: Platform-specific code (C# for Unity, Lua for Roblox, etc.)
  • Tools: Utility scripts and editor extensions
  • Shaders: Custom shader implementations

Prefabs

  • Pre-configured, ready-to-use entities or objects specific to the platform

4. Contribution Guidelines

File Naming

  • Use descriptive, lowercase names with hyphens: my-awesome-script.cs
  • Include version numbers when applicable: ui-system-v2.prefab

Documentation

  • Include a README.md in your contribution folder explaining:
    • What the asset/code does
    • How to use it
    • Any dependencies or requirements
    • License information (if different from repository license)

Code Quality

  • Follow platform-specific coding standards
  • Include comments explaining complex logic
  • Test your code before submitting

Asset Quality

  • Optimize file sizes when possible
  • Include source files when appropriate
  • Provide multiple format options when beneficial

5. Submission Process

  1. Commit your changes with descriptive messages
  2. Push to your fork
  3. Create a Pull Request with:
    • Clear title describing your contribution
    • Detailed description of what you're adding
    • Screenshots or demos if applicable
    • Any special installation or usage instructions

6. Review Process

  • Maintainers will review your contribution
  • You may be asked to make changes or provide additional documentation
  • Once approved, your contribution will be merged

Community Standards

  • Be respectful and inclusive
  • Help others learn and grow
  • Share knowledge freely
  • Credit original creators when building upon existing work

Questions?

  • Open an issue for general questions
  • Tag maintainers in your PR for specific feedback
  • Join our community discussions

Thank you for helping build the metaverse development community!