diff options
author | Maxim Tsoy <maks.tsoy@gmail.com> | 2019-05-07 15:13:28 +0300 |
---|---|---|
committer | Maxim Tsoy <maks.tsoy@gmail.com> | 2019-05-07 15:17:17 +0300 |
commit | 33307e6be3476ab93b789beb0f196ccb66ff16fa (patch) | |
tree | dbc3cc46682f28dc38d87f45d759f648cfce9694 | |
parent | d3540217e1772f1f1f39e39b5cc0a7b3b300b0d3 (diff) |
Fix readme formatting
-rw-r--r-- | README.md | 58 |
1 files changed, 30 insertions, 28 deletions
@@ -36,34 +36,36 @@ A [Hugo](https://gohugo.io/) theme to display a changelog ``` ## Description - 1. When a pull request is ready, a developer creates a changelog entry: - ```bash - make change - ``` - The command creates a *.md file with random name (ensures that there will be no merge conflicts) in `site/changelog/content/experimental/` folder - - 1a. If necessary, the developer creates a deprecation entry: - ```bash - make deprecation - ``` - The command creates a *.md file with random name (ensures that there will be no merge conflicts) in `site/changelog/content/deprecated/` folder. - Note that deprecation entries are not removed automatically. When a certain deprecated feature reaches the end of life period, the corresponding file in the `deprecation/` - folder has to be removed manually - - 2. The developer updates created files with changes. Changes are going to be rendered in the `experimental` section of the template - - 3. Preview the site with the command: - ```bash - make serve_changelog - ``` - - 4. When the working branch is ready to be merged in the stable branch, the developer runs: - ```bash - make release - ``` - The command will move all *.md files from the `experimental/` folder to the `released/` folder, assign the release version and generate the commit with related changes - - 5. The developer merges working branch in to the stable branch +1. When a pull request is ready, a developer creates a changelog entry: + ```bash + make change + ``` + The command creates a *.md file with random name (ensures that there will be no merge conflicts) in `site/changelog/content/experimental/` folder + +2. If necessary, the developer creates a deprecation entry: + + ```bash + make deprecation + ``` + + The command creates a *.md file with random name (ensures that there will be no merge conflicts) in `site/changelog/content/deprecated/` folder. + Note that deprecation entries are not removed automatically. When a certain deprecated feature reaches the end of life period, the corresponding + file in the `deprecation/` folder has to be removed manually + +3. The developer updates created files with changes. Changes are going to be rendered in the `experimental` section of the template + +4. Preview the site with the command: + ```bash + make serve_changelog + ``` + +5. When the working branch is ready to be merged in the stable branch, the developer runs: + ```bash + make release + ``` + The command will move all *.md files from the `experimental/` folder to the `released/` folder, assign the release version and generate the commit with related changes + +6. The developer merges working branch in to the stable branch # Shortcodes |