Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (43 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 2.64 KB

Contributing to JURASSIC (Juelich Rapid Spectral Simulation Code)

Thank you for your interest in contributing to the JURASSIC project. JURASSIC is a radiative transfer model designed to perform rapid and accurate spectral simulations for atmospheric science applications. Your contributions help improve the accuracy and efficiency of the model, and we greatly appreciate your support.

Code of Conduct

We are committed to fostering an open and welcoming environment. All participants, including contributors and maintainers, are expected to uphold our Code of Conduct, ensuring a harassment-free experience for everyone.

How to Contribute

Reporting Issues

If you encounter bugs, have feature requests, or seek clarification, please submit an issue through our GitHub Issues page. Provide detailed information to help us address the issue effectively:

  • A clear and descriptive title.
  • Steps to reproduce the issue (for bug reports).
  • Any relevant logs, error messages, or outputs.
  • The version of JURASSIC you're using and your computing environment.

Submitting Changes

  1. Fork the Repository: Click the "Fork" button at the top right corner of the JURASSIC GitHub page to create your own copy of the repository.

  2. Clone Your Fork:

    git clone https://github.com/your-username/jurassic.git

  3. Create a New Branch:

    cd jurassic
git checkout -b your-branch-name

  4. Implement Your Changes: Make your modifications, ensuring adherence to the project's coding standards.

  5. Commit Your Changes: Write clear and concise commit messages:

    git add .
git commit -m "Brief description of changes"

  6. Push to Your Fork:

    git push origin your-branch-name

  7. Submit a Pull Request:

    • Go to the original JURASSIC repository.
    • Click on "New Pull Request" and select your branch.
    • Provide a detailed description of your changes to facilitate the review process.

Coding Standards

  • Style Guide: Maintain consistency with the existing codebase. Follow standard coding practices relevant to the programming languages used in JURASSIC.
  • Documentation: Document new functions, classes, and modules thoroughly. Update existing documentation as necessary.
  • Testing: Ensure that your changes are accompanied by appropriate tests. Run tests before submitting a pull request.

License

By contributing to JURASSIC, you agree that your contributions will be licensed under the GNU General Public License v3.0.

We appreciate your contributions and dedication to advancing radiative transfer modeling with JURASSIC. Thank you for collaborating with us!