Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (40 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

56 lines (40 loc) · 1.13 KB

Contributing to Orbiter

Thank you for your interest in contributing to Orbiter!

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/yourusername/orbiter.git
  3. Install dependencies: npm install
  4. Create a branch: git checkout -b feature/your-feature-name

Development

Run the project locally:

npm start

Or in browser:

npm run web

Making Changes

  • Keep code clean and readable
  • Test your changes thoroughly
  • Ensure the simulation runs smoothly

Submitting Changes

  1. Commit your changes with clear messages
  2. Push to your fork
  3. Open a Pull Request with:
    • Description of what you changed
    • Why you made the change
    • Any relevant issue numbers

Code Style

  • Use clear, descriptive variable names
  • Keep functions focused and concise
  • No comments (code should be self-explanatory)

Ideas for Contributions

  • New physics simulations or interactions
  • Additional celestial body types
  • Performance optimizations
  • Visual effects and improvements
  • UI enhancements
  • Bug fixes

Questions?

Open an issue for discussion before starting major changes.