Skip to content

Latest commit

 

History

History
75 lines (44 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

75 lines (44 loc) · 2.48 KB

Contributing to Kriging Depth to Water (DTW) Project

Thank you for your interest in contributing to the Kriging Depth to Water (DTW) project! We welcome contributions from the community and appreciate your efforts to improve this project.

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request, please create an issue on GitHub. When reporting an issue, please include as much detail as possible, including steps to reproduce the problem, the environment in which it occurs, and any relevant logs or screenshots.

Submitting Pull Requests

  1. Fork the Repository:

    Fork the repository on GitHub and clone your fork locally.

    git clone https://github.com/inyo-gov/kriging-dtw.git
cd kriging-dtw

  2. Create a Branch:

    Create a new branch for your work.

    git checkout -b feature-name

  3. Make Changes:

    Make your changes to the codebase. Ensure that your code adheres to the project's coding standards.

  4. Commit Changes:

    Commit your changes with a descriptive commit message.

    git commit -m "Description of the feature or fix"

  5. Push Changes:

    Push your changes to your forked repository.

    git push origin feature-name

  6. Create a Pull Request:

    Go to the original repository on GitHub and create a pull request from your forked repository. Provide a clear and detailed description of your changes.

Coding Standards

Please follow these coding standards when contributing to the project:

  • Write clear and concise code.
  • Use meaningful variable and function names.
  • Comment your code where necessary to explain complex logic.
  • Follow the existing coding style of the project.

Running Tests

Before submitting a pull request, ensure that your changes do not break any existing functionality. If the project has tests, run them to verify your changes. If tests are not available, please thoroughly test your changes manually.

Documentation

If your changes include new features or significant modifications, update the project documentation accordingly. This may include updating the README file, configuration files, or any other relevant documentation.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for contributing to the Kriging Depth to Water (DTW) project!