How to contribute?

There are several ways for developers and users to contribute to CoastalME:

• Contributing code
• Filing high-quality reports
• Improving documentation
• Credits

Contributing code

Minor changes to CoastalME, such as bug fixes, may be made by opening a GitHub pull request.

Major changes should be discussed on the CoastalME Discussions and may require the drafting of a RFC (request for comment) document.

CoastalME's policy on substantial code additions is documented at rfc_process.md.

Filing high-quality issue reports

Using the GitHub issue reports at the Master repository.

Improving documentation

CoastalME's documentation includes C++ API documentation built automatically from source comments using Doxygen and CodeDocx.XYZ files containing manually-edited content.

To be correctly parsed, the documentation should follow the Doxygen block documentation style

/*! \brief Brief description.
*         Brief description continued.
*
*  Detailed description starts here.
*/

Credits

This section has been largely inspired by https://github.com/OSGeo/gdal