diff --git a/source/content/principles/healthy_reference_best.md b/source/content/principles/healthy_reference_best.md index a3f233c..75346dc 100644 --- a/source/content/principles/healthy_reference_best.md +++ b/source/content/principles/healthy_reference_best.md @@ -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 %} diff --git a/source/content/principles/separate_best.md b/source/content/principles/separate_best.md index f55faf6..163c151 100644 --- a/source/content/principles/separate_best.md +++ b/source/content/principles/separate_best.md @@ -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. diff --git a/source/content/principles/states_best.md b/source/content/principles/states_best.md index a9366f5..777d413 100644 --- a/source/content/principles/states_best.md +++ b/source/content/principles/states_best.md @@ -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/)) diff --git a/source/content/principles/steps_best.md b/source/content/principles/steps_best.md index 086807b..b8d9eca 100644 --- a/source/content/principles/steps_best.md +++ b/source/content/principles/steps_best.md @@ -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. @@ -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 %} \ No newline at end of file