Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

66 lines (47 loc) · 1.47 KB

Contributing to Paloma's Orrery

Thank you for your interest in contributing! This guide will help you get started.

Development Setup

  1. Fork and clone the repository
  2. Install dependencies:
pip install -r requirements.txt

Code Guidelines

  • Follow PEP 8 style guide
  • Use descriptive variable names
  • Add docstrings for functions and classes
  • Include type hints where applicable
  • Comment complex code sections
  • Keep functions focused and modular

Pull Request Process

  1. Create a feature branch from main
  2. Make commits with clear messages
  3. Update documentation if needed
  4. Run tests before submitting
  5. Submit PR with description of changes

Areas for Contribution

  • Bug fixes and performance improvements
  • New visualization features
  • Additional celestial objects support
  • Documentation improvements
  • Test coverage expansion

Adding New Features

When adding features:

  • Follow existing architecture patterns
  • Update README.md with new features
  • Add relevant tests
  • Document usage
  • Keep changes focused

Code Review Standards

Pull requests must:

  • Pass automated tests
  • Follow code style guide
  • Include documentation
  • Have clear commit history
  • Be reviewed by maintainers

Questions or Issues?

  • Open an issue for bugs/features
  • Join discussions
  • Contact maintainers

License

By contributing, you agree that your contributions will be licensed under the MIT License.