From 81ee09421e4a73af92abd805732de232e4644e54 Mon Sep 17 00:00:00 2001 From: Tidbit Software <34657535+TidbitSoftware@users.noreply.github.com> Date: Mon, 22 Jul 2024 14:13:55 -0700 Subject: [PATCH] Update README.md Testing Jenkins status badge --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b55750a99..bc5f4d1d7 100644 --- a/README.md +++ b/README.md @@ -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 git@github.com: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 ] +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