Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (44 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 2.85 KB

Contributing to MPTRAC

Thank you for your interest in contributing to the Massive-Parallel Trajectory Calculations (MPTRAC) project. MPTRAC is a Lagrangian particle dispersion model designed to analyze atmospheric transport processes in the free troposphere and stratosphere. (GitHub Repository)

To ensure a smooth and collaborative contribution process, please adhere to the following guidelines:

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 or error messages.
  • The version of MPTRAC you're using and your computing environment.

Submitting Changes

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

  2. Clone Your Fork:

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

  3. Create a New Branch:

    cd mptrac
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 MPTRAC 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 MPTRAC.
  • 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 MPTRAC, you agree that your contributions will be licensed under the GNU General Public License v3.0.

We appreciate your contributions and dedication to enhancing MPTRAC. Thank you for collaborating with us to advance atmospheric transport modeling!