-
Notifications
You must be signed in to change notification settings - Fork 133
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CONTRIBUTING, update README (#392)
* Add .md extension to pull request template * Add Contribution guide (CONTRIBUTING.md) Closes #384 * README: link to CONTRIBUTING * README: add more information * README: de-emphasize LANL * README, CONTRIBUTING: use 'Forum' instead of 'Bulletin Board' > The latter sounds like it's just for announcements, while "forum" invites discussion. #392 (review) * CONTRIBUTING: reserve issues for Consortium use Direct users to user the CICE forum for bug reports, feature proposal and futur development discussion. Also, emphasize that porting questions should first be directed to their local IT help desk. * CONTRIBUTING, README: link to 'Contributing' on the About-Us wiki The consensus on #392 was to create a 'Contributing' page in the About-Us wiki and link to there in both README.md and CONTRIBUTING.md. That page is created, so let's do that.
- Loading branch information
1 parent
0011980
commit 1287fbc
Showing
3 changed files
with
44 additions
and
5 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Contributing to CICE | ||
|
||
Welcome to the CICE Consortium ! First, thanks a lot for considering to contribute to CICE. | ||
|
||
There are many ways to contribute, and we appreciate your efforts. For an introductory tour, head over to our [Contribution guide][contributing] and take a look at the [Resources page], our go-to index with links to code, documentation, testing information, guidelines, and more. | ||
|
||
[contributing]: https://github.com/CICE-Consortium/About-Us/wiki/Contributing | ||
[resources]: https://github.com/CICE-Consortium/About-Us/wiki/Resource-Index | ||
|
||
## Getting help | ||
If you still need help getting started using the model afer reviewing the [model documentation][doc-running], the first point of contact with the CICE Consortium is the [Consortium Community Forum][forum]. | ||
This forum is monitored by Consortium members and also opened to the whole community. | ||
**Please do not use our issue tracker for general support questions.** | ||
|
||
[doc-running]: https://cice-consortium-cice.readthedocs.io/en/master/user_guide/ug_running.html | ||
[forum]: https://xenforo.cgd.ucar.edu/cesm/forums/cice-consortium.146/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters