Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (33 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.81 KB

Contributing to RAPID

Thank you for your interest in contributing to RAPID (Roman Alerts Promptly from Image Differencing). This document provides guidelines for contributing to the project.

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

How to Contribute

Reporting Issues

  • Use the GitHub Issues tracker to report bugs or request features.
  • Before opening a new issue, search existing issues to avoid duplicates.
  • When reporting a bug, include:
    • A clear, descriptive title
    • Steps to reproduce the issue
    • Expected vs. actual behavior
    • Your environment (OS, Python version, relevant package versions)

Submitting Changes

  1. Fork the repository and create a feature branch from main.
  2. Make your changes in the feature branch.
  3. Write or update tests as appropriate.
  4. Ensure all tests pass before submitting.
  5. Submit a pull request with a clear description of the changes.

Pull Request Guidelines

  • Keep pull requests focused — one feature or fix per PR.
  • Include a clear description of what the PR does and why.
  • Reference any related issues (e.g., "Fixes #42").
  • Ensure your code follows the existing style and conventions of the project.
  • Update documentation if your changes affect it.

Coding Standards

  • Follow PEP 8 for Python code.
  • Include docstrings for public functions, classes, and modules.
  • Write meaningful commit messages.

Review and Acceptance

Please note that all contributions are subject to review. The project maintainers reserve the right to accept or reject any contribution at their discretion.

Questions

If you have questions about contributing, please open an issue on GitHub or consult the documentation.