Skip to content

Commit

Permalink
deploy: 935fea4
Browse files Browse the repository at this point in the history
  • Loading branch information
@amyheather
amyheather committed Jun 19, 2024
1 parent 8ad1b4f commit 1eeeac6
Show file tree
Hide file tree
Showing 3 changed files with 199 additions and 1 deletion.
77 changes: 77 additions & 0 deletions _sources/programming_notes/git.md.txt
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,82 @@
# Git

## Conventional commits

VSCode has extension `Conventional Commits` to help with following this criteria.

Format:

```
type(scope): description

body

footer
```

If you have a breaking change (correlates with `major` in semantic versioning) you need to:
* Add a "!" after type/scope
* In footer, have "BREAKING CHANGE: description of change"

Type (mandatory):

| Type | Summary | Description |
| --- | --- | --- |
| `style` | Styles | Commit doesn't affect meaning (white-space, formatting, missing semi-colons, etc.) |
| `docs` | Documentation | Commit affects documentation only (correlates with `patch` in semantic versioning) |
| `refactor` | Code refactoring | Commit rewrites/restructures code but doesn't change expected behaviour of code |
| `perf` | Performance improvements | Commit rewrites/restructures code to improve performance (but doesn't change expected behaviour of code) |
| `improvement` | Improvement | Commit improves current implementation without adding new feature or fixing bug (would have no effect on semantic versioning) |
| `feat` | Features | New feature | Commit adds new feature (correlates with `minor` in semantic versioning) (whilst keeping backward compatability) |
| `fix` | Bug fixes | Bug fix | Commit fixes bug (correlates with `patch` in semantic versioning) |
| `test` | Test | Commit adds or amends tests |
| `build` | Builds | Commit affects build system or external dependencies (e.g. adding, removing, upgrading dependencies) |
| `ops` | Operational | Commit affects operational components (e.g. infrastructure, deployment, backup, recovery) |
| `chore` | Chores | Miscellanous commit (e.g. modifying `.gitignore`, regenerating generated code, releasing product) |
| `revert` | Reverts | Revert to old commit |
| `ci` | Continuous integrations (CI) | Commit changes CI files (e.g. Travis) |

Scope (optional)

Description (mandatory)
* Concise description of change in present tense
* Don't capitalise first letter, and no dot (`.`) at end

Body (optional)
* Motivation for change and contrast with previous behaviour, in present tense
* Must have one blank line before

Footer (optional)
* Must have one blank line before
* Should include issue ref (e.g. `Fixes: #13`). As long as you use one of GitHub's key words, it will automatically create a link. (`close`, `closes`, `closed`, `fix`, `fixes`, `fixed`, `resolve`, `resolves`, `resolved`). If for a commit in a different repository, then e.g. `Resolves: neudesic/projectcenter#22`
* Should only include BREAKING CHANGE, external links, issue references, and other meta-information

Examples:

```
fix: add missing parameter to service call

The error occurred because of <reasons>.
```

```
feat!: remove ticket list endpoint

refers to JIRA-1337

BREAKING CHANGES: ticket enpoints no longer supports list all entites.
```

```
feat(shopping cart): add the amazing button
```

Sources:
* <https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index>
* <https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13>
* <https://www.conventionalcommits.org/en/v1.0.0-beta.2/>
* <https://medium.com/neudesic-innovation/conventional-commits-a-better-way-78d6785c2e08>

## Download folder from a GitHub repository

Replace `.com` in the URL with `.dev`. This will open an editor, where you can then right click the folder in the sidebar and select download.
Expand Down
121 changes: 121 additions & 0 deletions programming_notes/git.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,126 @@

<div class="section" id="git">
<h1>Git<a class="headerlink" href="#git" title="Permalink to this heading">#</a></h1>
<div class="section" id="conventional-commits">
<h2>Conventional commits<a class="headerlink" href="#conventional-commits" title="Permalink to this heading">#</a></h2>
<p>VSCode has extension <code class="docutils literal notranslate"><span class="pre">Conventional</span> <span class="pre">Commits</span></code> to help with following this criteria.</p>
<p>Format:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">type</span><span class="p">(</span><span class="n">scope</span><span class="p">):</span> <span class="n">description</span>

<span class="n">body</span>

<span class="n">footer</span>
</pre></div>
</div>
<p>If you have a breaking change (correlates with <code class="docutils literal notranslate"><span class="pre">major</span></code> in semantic versioning) you need to:</p>
<ul class="simple">
<li><p>Add a “!” after type/scope</p></li>
<li><p>In footer, have “BREAKING CHANGE: description of change”</p></li>
</ul>
<p>Type (mandatory):</p>
<table class="colwidths-auto table">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Summary</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">style</span></code></p></td>
<td><p>Styles</p></td>
<td><p>Commit doesn’t affect meaning (white-space, formatting, missing semi-colons, etc.)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">docs</span></code></p></td>
<td><p>Documentation</p></td>
<td><p>Commit affects documentation only (correlates with <code class="docutils literal notranslate"><span class="pre">patch</span></code> in semantic versioning)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">refactor</span></code></p></td>
<td><p>Code refactoring</p></td>
<td><p>Commit rewrites/restructures code but doesn’t change expected behaviour of code</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">perf</span></code></p></td>
<td><p>Performance improvements</p></td>
<td><p>Commit rewrites/restructures code to improve performance (but doesn’t change expected behaviour of code)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">improvement</span></code></p></td>
<td><p>Improvement</p></td>
<td><p>Commit improves current implementation without adding new feature or fixing bug (would have no effect on semantic versioning)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">feat</span></code></p></td>
<td><p>Features</p></td>
<td><p>New feature</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">fix</span></code></p></td>
<td><p>Bug fixes</p></td>
<td><p>Bug fix</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">test</span></code></p></td>
<td><p>Test</p></td>
<td><p>Commit adds or amends tests</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">build</span></code></p></td>
<td><p>Builds</p></td>
<td><p>Commit affects build system or external dependencies (e.g. adding, removing, upgrading dependencies)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ops</span></code></p></td>
<td><p>Operational</p></td>
<td><p>Commit affects operational components (e.g. infrastructure, deployment, backup, recovery)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">chore</span></code></p></td>
<td><p>Chores</p></td>
<td><p>Miscellanous commit (e.g. modifying <code class="docutils literal notranslate"><span class="pre">.gitignore</span></code>, regenerating generated code, releasing product)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">revert</span></code></p></td>
<td><p>Reverts</p></td>
<td><p>Revert to old commit</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ci</span></code></p></td>
<td><p>Continuous integrations (CI)</p></td>
<td><p>Commit changes CI files (e.g. Travis)</p></td>
</tr>
</tbody>
</table>
<p>Scope (optional)</p>
<p>Description (mandatory)</p>
<ul class="simple">
<li><p>Concise description of change in present tense</p></li>
<li><p>Don’t capitalise first letter, and no dot (<code class="docutils literal notranslate"><span class="pre">.</span></code>) at end</p></li>
</ul>
<p>Body (optional)</p>
<ul class="simple">
<li><p>Motivation for change and contrast with previous behaviour, in present tense</p></li>
<li><p>Must have one blank line before</p></li>
</ul>
<p>Footer (optional)</p>
<ul class="simple">
<li><p>Must have one blank line before</p></li>
<li><p>Should include issue ref (e.g. <code class="docutils literal notranslate"><span class="pre">Fixes:</span> <span class="pre">#13</span></code>). As long as you use one of GitHub’s key words, it will automatically create a link. (<code class="docutils literal notranslate"><span class="pre">close</span></code>, <code class="docutils literal notranslate"><span class="pre">closes</span></code>, <code class="docutils literal notranslate"><span class="pre">closed</span></code>, <code class="docutils literal notranslate"><span class="pre">fix</span></code>, <code class="docutils literal notranslate"><span class="pre">fixes</span></code>, <code class="docutils literal notranslate"><span class="pre">fixed</span></code>, <code class="docutils literal notranslate"><span class="pre">resolve</span></code>, <code class="docutils literal notranslate"><span class="pre">resolves</span></code>, <code class="docutils literal notranslate"><span class="pre">resolved</span></code>). If for a commit in a different repository, then e.g. <code class="docutils literal notranslate"><span class="pre">Resolves:</span> <span class="pre">neudesic/projectcenter#22</span></code></p></li>
<li><p>Should only include BREAKING CHANGE, external links, issue references, and other meta-information</p></li>
</ul>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">fix</span><span class="p">:</span> <span class="n">add</span> <span class="n">missing</span> <span class="n">parameter</span> <span class="n">to</span> <span class="n">service</span> <span class="n">call</span>

<span class="n">The</span> <span class="n">error</span> <span class="n">occurred</span> <span class="n">because</span> <span class="n">of</span> <span class="o">&lt;</span><span class="n">reasons</span><span class="o">&gt;.</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>feat!: remove ticket list endpoint

refers to JIRA-1337

BREAKING CHANGES: ticket enpoints no longer supports list all entites.
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">feat</span><span class="p">(</span><span class="n">shopping</span> <span class="n">cart</span><span class="p">):</span> <span class="n">add</span> <span class="n">the</span> <span class="n">amazing</span> <span class="n">button</span>
</pre></div>
</div>
<p>Sources:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index">https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index</a></p></li>
<li><p><a class="reference external" href="https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13">https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13</a></p></li>
<li><p><a class="reference external" href="https://www.conventionalcommits.org/en/v1.0.0-beta.2/">https://www.conventionalcommits.org/en/v1.0.0-beta.2/</a></p></li>
<li><p><a class="reference external" href="https://medium.com/neudesic-innovation/conventional-commits-a-better-way-78d6785c2e08">https://medium.com/neudesic-innovation/conventional-commits-a-better-way-78d6785c2e08</a></p></li>
</ul>
</div>
<div class="section" id="download-folder-from-a-github-repository">
<h2>Download folder from a GitHub repository<a class="headerlink" href="#download-folder-from-a-github-repository" title="Permalink to this heading">#</a></h2>
<p>Replace <code class="docutils literal notranslate"><span class="pre">.com</span></code> in the URL with <code class="docutils literal notranslate"><span class="pre">.dev</span></code>. This will open an editor, where you can then right click the folder in the sidebar and select download.</p>
Expand Down Expand Up @@ -634,6 +754,7 @@ <h2>Public v.s. private repositories<a class="headerlink" href="#public-v-s-priv
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#conventional-commits">Conventional commits</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#download-folder-from-a-github-repository">Download folder from a GitHub repository</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#create-and-delete-repositories">Create and delete repositories</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#add-rename-remove-push">Add, rename, remove, push</a></li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 1eeeac6

Please sign in to comment.