Merge pull request ESMCI#407 from ekluzek/GHtemplates

Initial version of templates for contributing, PR's and issues

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,21 @@
+### General Type of Issue:
+Some example types are:
+- bug
+- enhancement
+- question
+
+### Details of Issue:
+(Be sure to give enough details that the issue can be understood sufficiently 
+to replicate or to make the required changes)
+
+### For bugs fill out the following: (Otherwise remove, and remove any prompts that aren't useful)
+-----------------------------------------------------------------
+#### Important Details of your setup/configuration (compset, settings, etc.):
+
+#### Important output or errors that show the problem:
+
+#### What is the CTSM version you are using (output of git describe)?:
+
+#### What is the machine you are running on:?
+
+-----------------------------------------------------------------

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+### Description of changes:
+
+### CTSM Issues Fixed (include github issue #):
+
+### Are answers expected to change? (and if so in what way):
+
+### Any User Interface Changes (namelist or namelist defaults changes)?:
+
+### Testing performed:
+(List what testing you did to show your changes worked as expected)
+(This can be manual testing or running of the different test suites)
+
+### NOTE: Be sure to check your Coding style against the standard:
+https://github.com/ESCOMP/ctsm/wiki/CTSM-coding-guidelines

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+## How to contribute:
+
+It's recommended that you first contact [email protected] to discuss the changes or additions that you propose.
+Work with them to think about the design and implemention of the changes as well as the planning
+and scheduling for the change to come into CTSM.
+
+It's also recommened that you join the [email protected] google groups in order 
+to be informed about the science that is happening in CTSM as well as the latest develepments and tags.
+The ctsm-dev group is here:
+
+https://groups.google.com/a/ucar.edu/forum/#!forum/ctsm-dev
+
+Use the help from the wiki below to setup a fork and personal branch in GitHub to put your developments
+on and keep up to date with the master branch of CTSM. Once the changes are sufficiently advanced you
+can form a Pull Request on GitHub. Either from your fork on GitHub, or from the main ESCOMP GitHub page
+for CTSM (be sure to hit the "compare across forks" link at the top of the page when you first create
+the pull request).
+
+https://github.com/ESCOMP/ctsm/pulls
+
+This allows you to show your proposed changes and start getting feedback on them (even if they aren't finished). 
+This also allows your changes to be planned for and slated for a time to come into CTSM master. In most 
+cases you won't merge the Pull Request yourself, but a software engineer responsible for CTSM will do 
+additional testing and bring the changes to CTSM master.
+
+### CTSM Developers Guide:
+
+ https://wiki.ucar.edu/display/ccsm/Community+Land+Model+Developers+Guide
+
+## Getting Started:
+
+The following resources give you information on the project and how to get started.
+
+#### CTSM Wiki:
+
+https://github.com/ESCOMP/ctsm/wiki
+
+#### Coding Practices and Style:
+
+Code conventions: https://github.com/ESCOMP/ctsm/wiki/CTSM-coding-guidelines
+
+#### Code of Conduct:
+
+See the "CODE_OF_CONDUCT.md" file for expectations of how to work in the community.

README

@@ -5,7 +5,7 @@ offline-build and test scripts. This gives you everything you need
 to run CLM with CESM with datm8 to provide CRU NCEP or GSWP3 forcing data in 
 place of a modeled atmosphere.
 
-For lists of current bugs (issues) and current development see the CTSM github page:
+For lists of current bugs (issues) and current development see the CTSM GitHub page:
 
 https://github.com/ESCOMP/ctsm
 

README_EXTERNALS.rst

@@ -1,7 +1,7 @@
 Obtaining the full model code and associated scripting infrastructure
 =====================================================================
 
-CTSM is released via github. You will need some familiarity with git in order
+CTSM is released via GitHub. You will need some familiarity with git in order
 to modify the code and commit these changes. However, to simply checkout and run the
 code, no git knowledge is required other than what is documented in the following steps.
 
@@ -115,7 +115,7 @@ Committing your change to Externals.cfg
 After making this change, it's a good idea to commit the change in your
 local CTSM git repository. First create a branch in your local
 repository, then commit it. (Unlike with subversion, branches are stored
-locally unless you explicitly push them up to github. Feel free to
+locally unless you explicitly push them up to GitHub. Feel free to
 create whatever local branches you'd like.) For example::
 
   git checkout -b my_ctsm_branch