Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (33 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.6 KB

Contributing to sunflow

Thank you for your interest in contributing to sunflow! This is a collaborative project based at the Danish Meteorological Institute for implementing open-source satellite-based solar nowcasting.

Getting Started

Before contributing, follow the local development setup steps in the README.

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/<your-username>/sunflow.git
cd sunflow
  3. Create a branch for your changes: 
    git checkout -b feature/your-feature-name

Development Guidelines

Commits

  • Write clear and concise commit messages.
  • Use the imperative mood in the subject line (e.g., "Add solar irradiance model").
  • Reference relevant issues or pull requests where applicable.
  • Add an entry to CHANGELOG.md describing your change under the [Unreleased] section.

Submitting Changes

  1. Push your branch to your fork: 
    git push origin feature/your-feature-name
  2. Open a Pull Request against the main branch of dmidk/sunflow.
  3. Describe your changes clearly in the pull request description.
  4. Ensure all tests pass and there are no linting errors.
  5. A maintainer will review your pull request and may request changes.

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub with a clear description and, where relevant, a minimal reproducible example.

License

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