Skip to content

Commit a95f1aa

Browse files
committed
Edits to the contributing document
1 parent 6b0c9b6 commit a95f1aa

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
# Contributing
22

3-
VIC is Open Source software. Our rationale for moving the VIC model development to the open source community is that we want:
3+
VIC is Open Source software. This means that the code is made available for free, but also that development, maintenance and support need to be community efforts. Our rationale for moving the VIC model development to the open source community is that we want:
44

5-
- to encourage other researchers and developers to contribute to the VIC development, and
5+
- to encourage other researchers and developers to contribute to VIC development, and
66
- to facilitate transparent development and use of the model.
77

8-
## Official Support
8+
## Support
99

10-
The VIC development community assumes the role of a limited scope of official support.
10+
There is no official support for the VIC model, other than the VIC documentation, the VIC source code archive and the description of the model in the literature. Any additional support relies on volunteer efforts by the VIC development community, which means that no one is being paid to provide VIC support. The following resources are available:
1111

12-
- Coordination of model development, bug fixes, and releases.
13-
- Distribution of model [documentation](http://vic.readthedocs.org) and [source code](https://github.com/UW-Hydro/VIC).
12+
- [VIC Source code repository](https://github.com/UW-Hydro/VIC) : Source code distribution, coordination of model development, bug fixes, and releases.
13+
- [VIC documentation](http://vic.readthedocs.org) at readthedocs.org.
1414

15-
## Unsupported
16-
17-
Due to limited resources, there is not official support for some of the tasks related to using VIC. We expected that the user comes prepared with some understanding of the model and scientific computing. As such, these items are specifically not supported by the VIC development community:
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 VIC development community:
1816

1917
- Building and running the VIC model on platforms other than LINUX, UNIX, and OSX.
2018
- Using LINUX, UNIX, or OSX operating systems.
@@ -25,7 +23,7 @@ Due to limited resources, there is not official support for some of the tasks re
2523

2624
The VIC user and developer community is quite large and is spread all around the world. Depending on the question or issue your facing, there are a number of avenues to get in-touch:
2725

28-
VIC Users Listserve: [![VIC Users Listserve](https://img.shields.io/badge/VIC%20Users%20Listserve-Active-blue.svg)](https://mailman.u.washington.edu/mailman/listinfo/vic_users)
26+
VIC Users Listserv: [![VIC Users Listserv](https://img.shields.io/badge/VIC%20Users%20Listserve-Active-blue.svg)](https://mailman.u.washington.edu/mailman/listinfo/vic_users)
2927

3028
Developers Gitter Room: [![Join the chat at https://gitter.im/UW-Hydro/VIC](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/UW-Hydro/VIC?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
3129

@@ -38,19 +36,22 @@ If you think you have found a bug in VIC, please file an issue on Github [here](
3836

3937
- Version of VIC that you are using (e.g. VIC.4.2.b)
4038
- Name and version of the C compiler you are using
39+
- Operating system
4140
- A description of relevant model settings
4241
- A summary of the bug or error message you are getting
4342

43+
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.
44+
4445
#### Requesting New features
4546

46-
The VIC model is under active development. If you would like to propose a new feature, driver, or extension to the VIC model, please raise a Github issue [here](https://github.com/UW-Hydro/VIC/issues). Also, because VIC is an open source model with little official support, please also be prepared to contribute to the implementation of your feature request.
47+
The VIC model is under active development. If you would like to propose a new feature, driver, or extension to the VIC model, please raise a Github issue [here](https://github.com/UW-Hydro/VIC/issues). Also, because VIC is an open source model with no official support for development, be prepared to contribute to the implementation of your feature request. Also note that 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).
4748

4849
## Contributing to VIC
4950
#### Git Workflow
50-
New to Git but want to contribute to VIC, we have developed some documentation to help you get started:
51+
We have developed some documentation to help you get started if you are new to Git but want to contribute to VIC:
5152

5253
- [Working with Git](http://vic.readthedocs.org/en/latest/Development/working-with-git/)
5354
- [Git Workflow](http://vic.readthedocs.org/en/latest/Development/git-workflow/)
5455

5556
#### Style Guide
56-
To be added soon. For now, please remember to comment your code well and [use `uncrustify` to format your code properly](https://github.com/UW-Hydro/VIC/tree/master/tools/code_format).
57+
To be added soon. For now, please remember to comment your code well and [use `uncrustify` to format your code properly](https://github.com/UW-Hydro/VIC/tree/master/tools/code_format).

0 commit comments

Comments
 (0)