Contributors Guide#

Introduction#

Welcome to the pyDARTdiags contributors guide! We appreciate your interest in contributing to the project. Whether you’re fixing bugs, adding new features, improving documentation, or writing tests, please follow the contributors guide.

What Can I Do?#

There are many ways you can contribute to pyDARTdiags:

  • Report Bugs: If you find a bug, please report it by opening an issue.

  • Fix Bugs: Look through the issue tracker for bugs that need fixing.

  • Add Features: If you have an idea for a new feature, open an issue to discuss it before starting work.

  • Improve Documentation: Help us improve our documentation by making it clearer and more comprehensive, or adding examples.

  • Write Tests: We use the pytest framework.

Reporting a Bug#

If you find a bug, please report it by opening an issue on our GitHub repository. Include as much detail as necessary to help us understand and reproduce the issue.

A bug report should contain the following:

  • The steps someone needs to take to reproduce the bug.

  • What you expected to happen.

  • What actually happened.

Source Code#

The source code for pyDARTdiags is available on our GitHub repository. Feel free to explore and understand the codebase.

Pull Requests#

We welcome pull requests! Please take a read through the Developer Guide for how to start developing with pyDARTdiags. To submit a pull request:

  1. Fork the Repository: Click the “Fork” button on the repository’s GitHub page.

  2. Create a Branch: Create a new branch for your work.

    git checkout -b my-feature-branch

  3. Make Changes: Make your changes and commit them.

  4. Push to Your Fork: Push your changes to your forked repository.

    git push origin my-feature-branch

  5. Open a Pull Request: Open a pull request from your forked repository to the main repository. Provide a description of your changes - the “why” - and note any issues that are being addressed.