|
| 1 | +# Contributing |
| 2 | + |
| 3 | +SUMMA is Open Source software. This means that the code is made available for free, but also that development, maintenance and support are intended to be community efforts. Our rationale for moving SUMMA model development to an open source model is that we want: |
| 4 | + |
| 5 | +- to encourage other researchers and developers to contribute to SUMMA development, and |
| 6 | +- to facilitate transparent development and use of the model. |
| 7 | + |
| 8 | +## Support |
| 9 | + |
| 10 | +There is no official support for the SUMMA model, other than the SUMMA documentation, the SUMMA source code archive and the description of the model in the literature. Any additional support relies on volunteer efforts by the SUMMA development community. The following resources are available: |
| 11 | + |
| 12 | +- [SUMMA web site](https://www.ral.ucar.edu/projects/summa): General background, SUMMA resources, and test data sets. |
| 13 | +- [SUMMA Source code repository](https://github.com/NCAR/SUMMA) : Source code distribution, coordination of model development, bug fixes, and releases. |
| 14 | + |
| 15 | +We expect that the user comes prepared with some understanding of the model and scientific computing. As such, these items are specifically not supported by the SUMMA development community: |
| 16 | + |
| 17 | +- Building and running the SUMMA model on platforms other than LINUX, UNIX, and OSX. |
| 18 | +- Using LINUX, UNIX, or OSX operating systems. |
| 19 | +- Development of project specific features. |
| 20 | +- Configuring individual model applications. |
| 21 | + |
| 22 | +## Submitting Issues |
| 23 | +#### Submitting Bug Reports |
| 24 | + |
| 25 | +If you think you have found a bug in SUMMA, please check whether an issue has been filed on [SUMMA's Github page](https://github.com/NCAR/SUMMA/issues). If not, go please go ahead and create an issue and include the following information in your bug report: |
| 26 | + |
| 27 | +- Version of SUMMA that you are using (e.g. SUMMA 1.0 - even better if you can provide the specific tag or commit) |
| 28 | +- Name and version of the fortran compiler you are using |
| 29 | +- Operating system |
| 30 | +- A description of relevant model settings |
| 31 | +- A summary of the bug or error message you are getting |
| 32 | + |
| 33 | +If you can provide more information that is great. If you know how to run the model in a debugger, you may be able to pinpoint where the problem occurs. |
| 34 | + |
| 35 | +#### Proposing New Features |
| 36 | + |
| 37 | +SUMMA is under active development. If you would like to propose a new feature, driver, or extension to SUMMA, please file an issue on [SUMMA's Github page](https://github.com/NCAR/SUMMA/issues). Also, because SUMMA is an open source model with no official support for general-purpose development, be prepared to contribute to the implementation of your feature request. Features that are only of interest to you are unlikely to be implemented in the main source code repo (although you are of course free to modify the code in any way you see fit). |
| 38 | + |
| 39 | +## Contributing to SUMMA |
| 40 | +#### Git Workflow |
| 41 | +We have developed some documentation to help you get started if you are new to Git but want to contribute to VIC: |
| 42 | + |
| 43 | +- [Working with Git](https://github.com/NCAR/summa/blob/master/docs/howto/git_howto.md) |
| 44 | +- [Git Workflow](https://github.com/NCAR/summa/blob/master/docs/howto/summa_git_workflow.md) |
| 45 | + |
| 46 | +#### Coding Conventions |
| 47 | +We have some simple [https://github.com/NCAR/summa/blob/master/docs/howto/summa_coding_conventions.md](coding conventions) that we would like anyone who contributes code to SUMMA to follow. |
0 commit comments