Skip to content

Commit

Permalink
layouting best practices
Browse files Browse the repository at this point in the history
  • Loading branch information
matteodelucchi committed Oct 25, 2024
1 parent 3a71b8b commit e396edd
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 0 deletions.
10 changes: 10 additions & 0 deletions source/content/principles/healthy_reference_best.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
### Best Practice (1/4)

{% if build == "slides" %}
```{admonition} Best Practices
:class: tip, margin
1. Keep a healthy reference
2.
3.
4.
```
{% endif %}

:::{card} Keep a healthy reference
- Identify one branch on one location to be the main reference{% if page %}[^sn1]{% endif %}
Expand Down
11 changes: 11 additions & 0 deletions source/content/principles/separate_best.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
### Best Practice (2/4)

{% if build == "slides" %}
```{admonition} Best Practices
:class: tip, margin
1. Keep a healthy reference
2. Separate changes
3.
4.
```
{% endif %}

:::{card} Use branches to isolate changes
- Agglomerate commits with a similar subject or purpose in a common branch
- Incorporate branches with completed purpose, e.g., a feature, a bug fix, or a documentation update is completed in its entirety.
Expand Down
11 changes: 11 additions & 0 deletions source/content/principles/states_best.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
### Best Practice (4/4)

{% if build == "slides" %}
```{admonition} Best Practices
:class: tip, margin
1. Keep a healthy reference
2. Separate changes
3. Commit complete changes
4. Regularly tag states
```
{% endif %}

:::{card} Regularly tag good states
- Tag particular states (see [**git tag** {octicon}`link-external;0.8em`](https://git-scm.com/docs/git-tag))
- Use a meaningful versioning framework to describe states (e.g., [semver {octicon}`link-external;0.8em`](https://semver.org/))
Expand Down
12 changes: 12 additions & 0 deletions source/content/principles/steps_best.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
### Best Practice (3/4)

{% if build == "slides" %}
```{admonition} Best Practices
:class: tip, margin
1. Keep a healthy reference
2. Separate changes
3. Commit complete changes
4.
```
{% endif %}

:::{card} Commit small but complete changes
- Decide what changes to include in a commit (use `git add -p`).
- Make a commit as specific as possible. I.e. include only changes that belong together.
Expand All @@ -8,4 +19,5 @@
:::
{% if build == "pages" %}
[^sn2]: As a guideline, you can use the [**Conventional Commits**](https://www.conventionalcommits.org/en/v1.0.0/) specification.

{% endif %}

0 comments on commit e396edd

Please sign in to comment.