Skip to content

Commit

Permalink
Deploying to gh-pages from @ fa8993f 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
Bai-Li-NOAA committed May 30, 2024
1 parent 8bb724d commit e583537
Show file tree
Hide file tree
Showing 14 changed files with 435 additions and 402 deletions.
3 changes: 2 additions & 1 deletion 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="FIMS Implementation Team" />


<meta name="date" content="2024-05-24" />
<meta name="date" content="2024-05-30" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -229,6 +229,7 @@
<li class="chapter" data-level="6.0.4" data-path="developer-software-guide.html"><a href="developer-software-guide.html#c-compiler"><i class="fa fa-check"></i><b>6.0.4</b> C++ compiler</a></li>
<li class="chapter" data-level="6.0.5" data-path="developer-software-guide.html"><a href="developer-software-guide.html#googletest"><i class="fa fa-check"></i><b>6.0.5</b> GoogleTest</a></li>
<li class="chapter" data-level="6.0.6" data-path="developer-software-guide.html"><a href="developer-software-guide.html#gdb-debugger"><i class="fa fa-check"></i><b>6.0.6</b> GDB debugger</a></li>
<li class="chapter" data-level="6.0.7" data-path="developer-software-guide.html"><a href="developer-software-guide.html#doxygen"><i class="fa fa-check"></i><b>6.0.7</b> Doxygen</a></li>
</ul></li>
<li class="chapter" data-level="7" data-path="contributor-guidelines.html"><a href="contributor-guidelines.html"><i class="fa fa-check"></i><b>7</b> Contributor Guidelines</a>
<ul>
Expand Down
3 changes: 2 additions & 1 deletion code-of-conduct.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="FIMS Implementation Team" />


<meta name="date" content="2024-05-24" />
<meta name="date" content="2024-05-30" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -229,6 +229,7 @@
<li class="chapter" data-level="6.0.4" data-path="developer-software-guide.html"><a href="developer-software-guide.html#c-compiler"><i class="fa fa-check"></i><b>6.0.4</b> C++ compiler</a></li>
<li class="chapter" data-level="6.0.5" data-path="developer-software-guide.html"><a href="developer-software-guide.html#googletest"><i class="fa fa-check"></i><b>6.0.5</b> GoogleTest</a></li>
<li class="chapter" data-level="6.0.6" data-path="developer-software-guide.html"><a href="developer-software-guide.html#gdb-debugger"><i class="fa fa-check"></i><b>6.0.6</b> GDB debugger</a></li>
<li class="chapter" data-level="6.0.7" data-path="developer-software-guide.html"><a href="developer-software-guide.html#doxygen"><i class="fa fa-check"></i><b>6.0.7</b> Doxygen</a></li>
</ul></li>
<li class="chapter" data-level="7" data-path="contributor-guidelines.html"><a href="contributor-guidelines.html"><i class="fa fa-check"></i><b>7</b> Contributor Guidelines</a>
<ul>
Expand Down
23 changes: 12 additions & 11 deletions contributor-guidelines.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="FIMS Implementation Team" />


<meta name="date" content="2024-05-24" />
<meta name="date" content="2024-05-30" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -229,6 +229,7 @@
<li class="chapter" data-level="6.0.4" data-path="developer-software-guide.html"><a href="developer-software-guide.html#c-compiler"><i class="fa fa-check"></i><b>6.0.4</b> C++ compiler</a></li>
<li class="chapter" data-level="6.0.5" data-path="developer-software-guide.html"><a href="developer-software-guide.html#googletest"><i class="fa fa-check"></i><b>6.0.5</b> GoogleTest</a></li>
<li class="chapter" data-level="6.0.6" data-path="developer-software-guide.html"><a href="developer-software-guide.html#gdb-debugger"><i class="fa fa-check"></i><b>6.0.6</b> GDB debugger</a></li>
<li class="chapter" data-level="6.0.7" data-path="developer-software-guide.html"><a href="developer-software-guide.html#doxygen"><i class="fa fa-check"></i><b>6.0.7</b> Doxygen</a></li>
</ul></li>
<li class="chapter" data-level="7" data-path="contributor-guidelines.html"><a href="contributor-guidelines.html"><i class="fa fa-check"></i><b>7</b> Contributor Guidelines</a>
<ul>
Expand Down Expand Up @@ -491,7 +492,7 @@ <h3><span class="header-section-number">7.5.2</span> Branch Protection<a href="c
<div id="github-cloning-and-branching" class="section level3 hasAnchor" number="7.5.3">
<h3><span class="header-section-number">7.5.3</span> GitHub cloning and branching<a href="contributor-guidelines.html#github-cloning-and-branching" class="anchor-section" aria-label="Anchor link to header"></a></h3>
<p>For contributors with write access to the FIMS repo, changes should be made on a feature branch after cloning the repo. The FIMS repo can be cloned to a local machine by using on the command line:</p>
<div class="sourceCode" id="cb14"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb14-1"><a href="contributor-guidelines.html#cb14-1" tabindex="-1"></a><span class="fu">git</span> clone https://github.com/NOAA-FIMS/FIMS.git</span></code></pre></div>
<div class="sourceCode" id="cb15"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb15-1"><a href="contributor-guidelines.html#cb15-1" tabindex="-1"></a><span class="fu">git</span> clone https://github.com/NOAA-FIMS/FIMS.git</span></code></pre></div>
</div>
<div id="outside-collaborators-and-forks" class="section level3 hasAnchor" number="7.5.4">
<h3><span class="header-section-number">7.5.4</span> Outside collaborators and forks<a href="contributor-guidelines.html#outside-collaborators-and-forks" class="anchor-section" aria-label="Anchor link to header"></a></h3>
Expand Down Expand Up @@ -604,23 +605,23 @@ <h3><span class="header-section-number">7.9.3</span> git workflow<a href="contri
<ol style="list-style-type: decimal">
<li>Use the following commands to create a branch:</li>
</ol>
<div class="sourceCode" id="cb15"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb15-1"><a href="contributor-guidelines.html#cb15-1" tabindex="-1"></a><span class="sc">$</span> git checkout <span class="sc">-</span>b <span class="sc">&lt;</span>branchname<span class="sc">&gt;</span> main <span class="co">#creates a local branch</span></span>
<span id="cb15-2"><a href="contributor-guidelines.html#cb15-2" tabindex="-1"></a><span class="sc">$</span> git push origin <span class="sc">&lt;</span>branchname<span class="sc">&gt;</span> <span class="co">#pushes branch back to gitHub</span></span></code></pre></div>
<div class="sourceCode" id="cb16"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb16-1"><a href="contributor-guidelines.html#cb16-1" tabindex="-1"></a><span class="sc">$</span> git checkout <span class="sc">-</span>b <span class="sc">&lt;</span>branchname<span class="sc">&gt;</span> main <span class="co">#creates a local branch</span></span>
<span id="cb16-2"><a href="contributor-guidelines.html#cb16-2" tabindex="-1"></a><span class="sc">$</span> git push origin <span class="sc">&lt;</span>branchname<span class="sc">&gt;</span> <span class="co">#pushes branch back to gitHub</span></span></code></pre></div>
<ol start="2" style="list-style-type: decimal">
<li>Periodically merge changes from main into branch</li>
</ol>
<div class="sourceCode" id="cb16"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb16-1"><a href="contributor-guidelines.html#cb16-1" tabindex="-1"></a><span class="sc">$</span> git merge main <span class="co">#merges changes from main into branch</span></span></code></pre></div>
<div class="sourceCode" id="cb17"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb17-1"><a href="contributor-guidelines.html#cb17-1" tabindex="-1"></a><span class="sc">$</span> git merge main <span class="co">#merges changes from main into branch</span></span></code></pre></div>
<ol start="3" style="list-style-type: decimal">
<li>While editing code, commit regularly following <a href="contributor-guidelines.html#commit-messages">commit messages</a> guidelines</li>
</ol>
<div class="sourceCode" id="cb17"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb17-1"><a href="contributor-guidelines.html#cb17-1" tabindex="-1"></a><span class="sc">$</span> git add <span class="sc">&lt;</span>filename<span class="sc">&gt;</span> <span class="co">#stages file for commit</span></span>
<span id="cb17-2"><a href="contributor-guidelines.html#cb17-2" tabindex="-1"></a><span class="er">$</span> git commit <span class="sc">-</span>m<span class="st">&quot;Commit Message&quot;</span> <span class="co">#commits changes</span></span></code></pre></div>
<div class="sourceCode" id="cb18"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb18-1"><a href="contributor-guidelines.html#cb18-1" tabindex="-1"></a><span class="sc">$</span> git add <span class="sc">&lt;</span>filename<span class="sc">&gt;</span> <span class="co">#stages file for commit</span></span>
<span id="cb18-2"><a href="contributor-guidelines.html#cb18-2" tabindex="-1"></a><span class="er">$</span> git commit <span class="sc">-</span>m<span class="st">&quot;Commit Message&quot;</span> <span class="co">#commits changes</span></span></code></pre></div>
<ol start="4" style="list-style-type: decimal">
<li>To push changes to gitHub, first set the upstream location:</li>
</ol>
<div class="sourceCode" id="cb18"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb18-1"><a href="contributor-guidelines.html#cb18-1" tabindex="-1"></a><span class="sc">$</span> git push <span class="sc">--</span>set<span class="sc">-</span>upstream origin <span class="sc">&lt;</span>branchname<span class="sc">&gt;</span> <span class="co">#pushes change to feature branch on gitHub</span></span></code></pre></div>
<div class="sourceCode" id="cb19"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb19-1"><a href="contributor-guidelines.html#cb19-1" tabindex="-1"></a><span class="sc">$</span> git push <span class="sc">--</span>set<span class="sc">-</span>upstream origin <span class="sc">&lt;</span>branchname<span class="sc">&gt;</span> <span class="co">#pushes change to feature branch on gitHub</span></span></code></pre></div>
<p>After which, changes can be pushed as:</p>
<div class="sourceCode" id="cb19"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb19-1"><a href="contributor-guidelines.html#cb19-1" tabindex="-1"></a><span class="sc">$</span> git push <span class="co">#pushes change to feature branch on gitHub</span></span></code></pre></div>
<div class="sourceCode" id="cb20"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb20-1"><a href="contributor-guidelines.html#cb20-1" tabindex="-1"></a><span class="sc">$</span> git push <span class="co">#pushes change to feature branch on gitHub</span></span></code></pre></div>
<ol start="4" style="list-style-type: decimal">
<li>When finished, create a pull request to the main branch following
<a href="#pull-request">pull request</a> guidelines</li>
Expand Down Expand Up @@ -807,8 +808,8 @@ <h2><span class="header-section-number">7.15</span> Clean up local branches<a hr
will merge the feature/bug branch back into the main repository and
delete the branch. At this stage, the contributor should also delete the
branch from the local repository using the following commands:</p>
<div class="sourceCode" id="cb21"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb21-1"><a href="contributor-guidelines.html#cb21-1" tabindex="-1"></a><span class="sc">$</span> git checkout main <span class="sc">/</span><span class="er">/</span>switches back to main branch</span>
<span id="cb21-2"><a href="contributor-guidelines.html#cb21-2" tabindex="-1"></a><span class="sc">$</span> git branch <span class="sc">-</span>d <span class="sc">&lt;</span>branchname<span class="sc">&gt;</span> <span class="er">//</span>deletes branch from local repository</span></code></pre></div>
<div class="sourceCode" id="cb22"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb22-1"><a href="contributor-guidelines.html#cb22-1" tabindex="-1"></a><span class="sc">$</span> git checkout main <span class="sc">/</span><span class="er">/</span>switches back to main branch</span>
<span id="cb22-2"><a href="contributor-guidelines.html#cb22-2" tabindex="-1"></a><span class="sc">$</span> git branch <span class="sc">-</span>d <span class="sc">&lt;</span>branchname<span class="sc">&gt;</span> <span class="er">//</span>deletes branch from local repository</span></code></pre></div>
</div>
<div id="github-actions" class="section level2 hasAnchor" number="7.16">
<h2><span class="header-section-number">7.16</span> GitHub Actions<a href="contributor-guidelines.html#github-actions" class="anchor-section" aria-label="Anchor link to header"></a></h2>
Expand Down
Loading

0 comments on commit e583537

Please sign in to comment.