Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (41 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

63 lines (41 loc) · 1.85 KB

Contributing to X_ITE

First of all, thank you for your interest in contributing to X_ITE! We welcome code improvements, bug reports, feature suggestions, documentation updates, and test cases.

This document outlines how to get involved.

Getting Started

  1. Fork the repository and clone your fork.
  2. Install Node.js (LTS version recommended).
  3. Install dependencies:
npm install
  1. Start the local development server:
  2. Visit http://localhost:****/ to run and test your changes.

Code Contributions

  • Please follow the existing code style.
  • Write descriptive commit messages.
  • Ensure your code passes linting and basic tests (npm test).

Suggested Improvements

  • Bug fixes in X3D nodes, rendering, parsing, etc.
  • Support for more X3D components and profiles.
  • Performance optimizations in scene graph traversal or shaders.
  • New examples and demos.

Reporting Issues

  • Please search existing issues before opening a new one.
  • Include a minimal reproducible example if reporting a bug.
  • Be clear about browser versions and platform if the bug is rendering-related.

Improving Documentation

  • Help us expand the API documentation.
  • Add code examples, explain X3D usage, or improve clarity.

Pull Request Checklist

  • Clear, focused scope (one feature or fix per PR).
  • Runs without errors.
  • Includes tests if applicable.
  • You have signed off on your work (git commit -s is welcome but not required).

License

By contributing, you agree that your contributions will be licensed under the same MIT License as the rest of the project.

Thank you for helping make X_ITE better!

The create3000 team