# # # Distribution Statement A. Approved for public release. Distribution unlimited.
# # #
# # # Author:
# # # Naval Research Laboratory, Marine Meteorology Division
# # #
# # # This program is free software: you can redistribute it and/or modify it under
# # # the terms of the NRLMMD License included with this program. This program is
# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of
# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license
# # # for more details. If you did not receive the license, for more information see:
# # # U-S-NRL-Marine-Meteorology-Division/

Contributors Guide#

The GeoIPS Team encourages active participation by the user and developer community, so we welcome any and all feedback on and updates to the code base.

Each step in this process can be completed by one or more individuals (we encourage collaboration!), so feel free to submit Issues even if you have no intention of resolving it yourself. And feel free to submit a Pull Request even if all tests are not complete - someone else may have time to finalize for approval even if you are unable.

Contributions generally follow the process of:

  1. Submit a GitHub Issue for a bug fix or feature request. GeoIPS GitHub Issue Creation Workflow

  2. Branch off a given Issue in order to make the required changes FROM WEB: MEMBERS: Create Branch from Existing Issue

  3. Create a github Pull Request in order for your changes to be reviewed prior to being merged to the integration branch GeoIPS GitHub Pull Request workflow

  4. Ensure all required tests pass prior to PR approval (more info coming soon)

    • Unit tests

    • Integration tests

    • Code formatting/style tests

    • Documentation formatting/style tests

  5. Merge your changes into the main code base! GeoIPS Merge PR and Close Issue workflow