Contributing

We welcome contributions from the community! Here's how to get started.

Setup

  • Fork the repo: https://github.com/ForestMars/PEDAL

  • Clone your fork and install dev dependencies

  • Run tests to verify your environment

Coding Standards

  • Follow PEP 8 for Python code

  • Use type hints and docstrings

  • Write clear, descriptive commit messages

Testing

  • Use pytest for unit and integration tests

  • Ensure all tests pass before submitting a PR

  • Aim for high test coverage

Pull Request Process

  • Create a feature branch for your work

  • Submit a PR to main with a clear description

  • Reference related issues in your PR

  • Participate in code review and address feedback

Issue Reporting

  • Use GitHub Issues for bugs and feature requests

  • Fill out the issue template with details and steps to reproduce

For admin and maintenance, see Administration

PreviousGetting HelpNextFeatures

Last updated