Thank you for taking time to contribute.
This repository contains the source for the RDHPCS Documentation located at https://docs.rdhpcs.noaa.gov.
Contributions to this project are released to the public under the project's open source license.
What follows is a set of guidelines and how-tos for contributing to libFMS. These are guidelines, not rules. Use your best judgement and feel free to propose changes to this document in a pull request.
Table of Contents
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to rdhpcs.help@noaa.gov.
- Create an issue that describes the change
- Fork the project
- Create a feature branch off an up-do-date
mainbranch - Update and commit the changes
- Push the commits to your fork
- Submit a pull request to the
mainbranch
When contributing to this project, please first open an issue. The issue title should be short and descriptive. The issue description should be clear and concise. Include enough information to help others reproduce the issue, or understand the change requested. Use GitHub flavored markdown to format the message, and include links to references.
Submit pull requests for bug fixes, improvements, or issues to particular problems in the documentation.
Please keep the changes in a single pull to be as small as possible to help reviewer(s) quickly evaluate changes. If you do have a large update, try to split the update into small, logical pull requests.
Please refer to the Contributing to these docs to review how to build and test the updates. All pull requests must pass all build tests without warnings or errors prior to being accepted.
Once a pull request is created, a member of the RDHPCS Documentation team will review the changes, and, if necessary, will work with the author of the pull request to modify their changes for correctness, and format.
Code updates should follow the coding style for the project, contained in CODE_STYLE.md.