Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (32 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 1.28 KB
Raw

Contributing to OpenRES

Thank you for your interest in contributing to OpenRES!

How to Contribute

Reporting Issues

If you find a bug or have a feature request:

  • Check the existing issues to avoid duplicates.
  • Open a new issue with a clear description and, if applicable, steps to reproduce.

Submitting Code Changes

  1. Fork the repository.
  2. Create a new branch:
git checkout -b feature/your-feature-name
  1. Make your changes, following the project’s coding style.
  2. Commit with clear messages:
git commit -m "Add: descriptive summary of changes"
  1. Push your branch and open a Pull Request.

Testing

If your PR affects processing algorithms, please:

  • Test using the sample data when possible to ensure reproducibility.
  • Describe how to validate your changes.
  • Add comments explaining key logic.

Style and Documentation

  • Use clear variable and function names.
  • Update docstrings and README sections when behavior changes.
  • Add or update user-facing screenshots if GUI elements change.

Code of Conduct

By participating, you agree to uphold the project's Code of Conduct.

We welcome contributions of all kinds — bug fixes, new features, documentation improvements, and workflow enhancements. Thanks for helping improve OpenRES!