Skip to content

Commit

Permalink
Deploying to gh-pages from @ c8102c4 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
iantaylor-NOAA committed Mar 21, 2024
1 parent cb5eefd commit 084488c
Show file tree
Hide file tree
Showing 13 changed files with 482 additions and 482 deletions.
6 changes: 3 additions & 3 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Page not found | FIMS Developer Handbook</title>
<meta name="description" content="This is a handbook for FIMS developers and contributors." />
<meta name="generator" content="bookdown 0.37 and GitBook 2.6.7" />
<meta name="generator" content="bookdown 0.38 and GitBook 2.6.7" />

<meta property="og:title" content="Page not found | FIMS Developer Handbook" />
<meta property="og:type" content="book" />
Expand All @@ -23,7 +23,7 @@
<meta name="author" content="FIMS Implementation Team" />


<meta name="date" content="2024-01-03" />
<meta name="date" content="2024-03-21" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -56,7 +56,7 @@

<style type="text/css">
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
Expand Down
6 changes: 3 additions & 3 deletions code-of-conduct.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Chapter 2 Code of conduct | FIMS Developer Handbook</title>
<meta name="description" content="This is a handbook for FIMS developers and contributors." />
<meta name="generator" content="bookdown 0.37 and GitBook 2.6.7" />
<meta name="generator" content="bookdown 0.38 and GitBook 2.6.7" />

<meta property="og:title" content="Chapter 2 Code of conduct | FIMS Developer Handbook" />
<meta property="og:type" content="book" />
Expand All @@ -23,7 +23,7 @@
<meta name="author" content="FIMS Implementation Team" />


<meta name="date" content="2024-01-03" />
<meta name="date" content="2024-03-21" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -56,7 +56,7 @@

<style type="text/css">
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
Expand Down
34 changes: 17 additions & 17 deletions contributor-guidelines.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Chapter 7 Contributor Guidelines | FIMS Developer Handbook</title>
<meta name="description" content="This is a handbook for FIMS developers and contributors." />
<meta name="generator" content="bookdown 0.37 and GitBook 2.6.7" />
<meta name="generator" content="bookdown 0.38 and GitBook 2.6.7" />

<meta property="og:title" content="Chapter 7 Contributor Guidelines | FIMS Developer Handbook" />
<meta property="og:type" content="book" />
Expand All @@ -23,7 +23,7 @@
<meta name="author" content="FIMS Implementation Team" />


<meta name="date" content="2024-01-03" />
<meta name="date" content="2024-03-21" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -56,7 +56,7 @@

<style type="text/css">
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
Expand Down Expand Up @@ -461,10 +461,10 @@ <h3><span class="header-section-number">7.5.1</span> FIMS Branching Strategy<a h
<p>The FIMS Project uses a <a href="https://trunkbaseddevelopment.com/">Scaled Trunk Based
Development</a> branching strategy to
make tasks easier without compromising quality.</p>
<div class="figure">
<img src="https://reviewpad.com/wp-content/uploads/2021/06/Scaled-Trunk-Based-Development.svg" alt="" />
<p class="caption">Scaled Trunk Based Development; image credit:
<a href="https://reviewpad.com/blog/github-flow-trunk-based-development-and-code-reviews/" class="uri">https://reviewpad.com/blog/github-flow-trunk-based-development-and-code-reviews/</a></p>
<div class="float">
<img src="https://reviewpad.com/wp-content/uploads/2021/06/Scaled-Trunk-Based-Development.svg" alt="Scaled Trunk Based Development; image credit: https://reviewpad.com/blog/github-flow-trunk-based-development-and-code-reviews/" />
<div class="figcaption">Scaled Trunk Based Development; image credit:
<a href="https://reviewpad.com/blog/github-flow-trunk-based-development-and-code-reviews/" class="uri">https://reviewpad.com/blog/github-flow-trunk-based-development-and-code-reviews/</a></div>
</div>
<p>This strategy is required for continuous integration and facilitates
knowledge of steps that must be taken prior to, during, and after making
Expand All @@ -488,7 +488,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="cb13"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb13-1"><a href="contributor-guidelines.html#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> clone https://github.com/NOAA-FIMS/FIMS.git</span></code></pre></div>
<div class="sourceCode" id="cb13"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb13-1"><a href="contributor-guidelines.html#cb13-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 @@ -601,23 +601,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="cb14"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb14-1"><a href="contributor-guidelines.html#cb14-1" aria-hidden="true" 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="cb14-2"><a href="contributor-guidelines.html#cb14-2" aria-hidden="true" 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="cb14"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb14-1"><a href="contributor-guidelines.html#cb14-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="cb14-2"><a href="contributor-guidelines.html#cb14-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="cb15"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb15-1"><a href="contributor-guidelines.html#cb15-1" aria-hidden="true" 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="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 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="cb16"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb16-1"><a href="contributor-guidelines.html#cb16-1" aria-hidden="true" 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="cb16-2"><a href="contributor-guidelines.html#cb16-2" aria-hidden="true" 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="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 add <span class="sc">&lt;</span>filename<span class="sc">&gt;</span> <span class="co">#stages file for commit</span></span>
<span id="cb16-2"><a href="contributor-guidelines.html#cb16-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="cb17"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb17-1"><a href="contributor-guidelines.html#cb17-1" aria-hidden="true" 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="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 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="cb18"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb18-1"><a href="contributor-guidelines.html#cb18-1" aria-hidden="true" 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="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="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 @@ -804,8 +804,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="cb20"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb20-1"><a href="contributor-guidelines.html#cb20-1" aria-hidden="true" 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="cb20-2"><a href="contributor-guidelines.html#cb20-2" aria-hidden="true" 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="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 checkout main <span class="sc">/</span><span class="er">/</span>switches back to main branch</span>
<span id="cb20-2"><a href="contributor-guidelines.html#cb20-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 084488c

Please sign in to comment.