aboutsummaryrefslogtreecommitdiffhomepage
path: root/content/en/contribute/documentation.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <[email protected]>2024-02-07 20:46:41 +0100
committerBjørn Erik Pedersen <[email protected]>2024-02-07 20:46:41 +0100
commit6efb279bfacbd7304cef994be8181c6f804e7dd4 (patch)
tree69a5547ad3598650a08d828e1dce64171dd5ea29 /content/en/contribute/documentation.md
parent9b0050e9aabe4be65c78ccf292a348f309d50ccd (diff)
downloadhugo-6efb279bfacbd7304cef994be8181c6f804e7dd4.tar.gz
hugo-6efb279bfacbd7304cef994be8181c6f804e7dd4.zip
Squashed 'docs/' changes from 5c085a37b..a9584e3d1
a9584e3d1 ci: bump GitHub workflow actions to latest versions f37ee374d Fix methods related to time.After a49214057 Correct heading render hook example 4b696f936 Update README.md b5a6e4039 Clean up the contributing section a5d79ed19 Fixed typo: instea → instead 6150a60e3 Remove the "local file templates" page 9395743dc Update/vendor theme 33d8c10cc Remove output format "name" parameter 7200ad97d Add security section to resources.GetRemote page 3f1e056b2 Remove erroneous front matter field 07c9a7e42 Add alpha index to glossary 6619c8aa0 Fix Page.Params example 145a92359 Simplify string concat example in math.Add 42488bb09 Add string concat example to math.Add eb20521a2 Fix flash of unstyled content with mathematical markup 74603bebe Fix typo in 'typesetting' git-subtree-dir: docs git-subtree-split: a9584e3d146c4a194d937a4dc8a37cde5ba1c618
Diffstat (limited to 'content/en/contribute/documentation.md')
-rw-r--r--content/en/contribute/documentation.md30
1 files changed, 21 insertions, 9 deletions
diff --git a/content/en/contribute/documentation.md b/content/en/contribute/documentation.md
index 862df619f..b0c376839 100644
--- a/content/en/contribute/documentation.md
+++ b/content/en/contribute/documentation.md
@@ -325,32 +325,44 @@ Step 2
: Clone your fork.
Step 3
-: Create a new branch with a descriptive name.
+: Create a new branch with a descriptive name that includes the corresponding issue number, if any:
```sh
-git checkout -b fix/typos-shortcode-templates
+git checkout -b restructure-foo-page-99999
```
Step 4
: Make changes.
Step 5
-: Commit your changes with a descriptive commit message, typically 50 characters or less. Add the "Closes" keyword if your change addresses one or more open [issues].
+: Build the site locally to preview your changes.
+
+Step 6
+: Commit your changes with a descriptive commit message:
+
+- Provide a summary on the first line, typically 50 characters or less, followed by a blank line.
+- Optionally, provide a detailed description where each line is 80 characters or less, followed by a blank line.
+- Optionally, add one or more "Fixes" or "Closes" keywords, each on its own line, referencing the [issues] addressed by this change.
+
+For example:
```sh
-git commit -m "Fix typos on the shortcode templates page
+git commit -m "Restructure the taxonomy page
+
+This restructures the taxonomy page by splitting topics into logical
+sections, each with one or more examples.
-Closes #1234
-Closes #5678"
+Fixes #9999
+Closes #9998"
```
-Step 6
+Step 7
: Push the new branch to your fork of the documentation repository.
-Step 7
+Step 8
: Visit the [documentation repository] and create a pull request (PR).
-Step 8
+Step 9
: A project maintainer will review your PR and may request changes. You may delete your branch after the maintainer merges your PR.
[ATX]: https://spec.commonmark.org/0.30/#atx-headings