Skip to content

Contributing Guidelines

Jorge Miguel Silva edited this page Oct 10, 2024 · 1 revision

Contributing Guidelines

We welcome contributions to PhenoQC! Here's how you can help:

Reporting Issues

  • Use the GitHub issue tracker to report bugs
  • Describe the bug concisely and clearly
  • Include steps to reproduce the issue

Suggesting Enhancements

  • Use the GitHub issue tracker to suggest enhancements
  • Clearly describe the enhancement and its potential benefits

Pull Requests

  1. Fork the repository
  2. Create a new branch (git checkout -b feature-branch)
  3. Make your changes
  4. Run tests (pytest)
  5. Commit your changes (git commit -am 'Add some feature')
  6. Push to the branch (git push origin feature-branch)
  7. Create a new Pull Request

Coding Standards

  • Follow PEP 8 guidelines
  • Write clear, commented code
  • Include unit tests for new features

Documentation

  • Update relevant documentation for any changes
  • Use clear and concise language

Thank you for contributing to PhenoQC!

Clone this wiki locally