-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
13 additions
and
7 deletions.
There are no files selected for viewing
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 |
---|---|---|
@@ -1,13 +1,14 @@ | ||
# Ice-sheet and Sea-level System Model - ISSM | ||
[![C/C++ CI](https://github.com/ISSMteam/ISSM/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/ISSMteam/ISSM/actions/) | ||
[![Jenkins - Linux Basic](https://ross.ics.uci.edu/jenkins/job/Debian_Linux-Basic/lastBuild/buildStatus))](https://ross.ics.uci.edu/jenkins/job/Debian_Linux-Basic/lastBuild/buildStatus) | ||
|
||
## Description | ||
ISSM is a large-scale thermo-mechanical 2D/3D parallelized multi-purpose finite-element software dedicated to ice sheet and sea-level modeling. | ||
|
||
## Contact | ||
- Forum: https://issm.ess.uci.edu/forum/ | ||
- GitHub: https://github.com/ISSMteam/ISSM | ||
- Website: http://issm.jpl.nasa.gov/ | ||
- Forum: https://issm.ess.uci.edu/forum | ||
- GitHub: https://github.com/ISSMteam/ISSM | ||
- Website: https://issm.jpl.nasa.gov | ||
|
||
## Checking Out a Copy of the Repository | ||
Navigate to the parent directory where you want the ISSM repository to be located and run, | ||
|
@@ -19,7 +20,7 @@ or | |
git clone [email protected]:ISSMteam/ISSM.git | ||
``` | ||
|
||
## Committing Changes to Repository | ||
## Committing Changes to the Repository | ||
A good basic workflow for committing changes to the repository is, | ||
|
||
1. Stash your local changes | ||
|
@@ -39,9 +40,14 @@ git stash apply | |
|
||
4. Add, commit, and push your changes | ||
``` | ||
git add | ||
git commit [-m <MSG>] | ||
git add [file] | ||
git commit [-m "descriptive commit message"] | ||
git push | ||
``` | ||
|
||
You should then submit a pull request via GitHub so that project admins can review your changes and merge them into the main branch. | ||
5. If you have forked the ISSM repository, consider making sure that your commit passes CI workflows before submitting a pull request. | ||
|
||
6. Submit a pull request via GitHub so that project admins can review your changes and merge them into the main branch. | ||
|
||
## Resources | ||
- Git Guides: https://github.com/git-guides |