Skip to content

Commit 41f9603

Browse files
committed
fix: correct formatting in README.md for clarity and consistency
1 parent b324dd4 commit 41f9603

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ npm test
4242

4343
Tired of repetitive setup, inconsistent code, and integration headaches? See how `js-quality-started-with-release` provides a superior foundation compared to starting from scratch or using basic boilerplates.
4444

45-
| Criteria | Minimal/Empty Repository | Basic Boilerplate | `js-quality-started-with-release` Template |
45+
| Criteria | Minimal/Empty Repository | Basic Boilerplate | `js-quality-started-with-release` Template |
4646
| :--------------------------------- | :----------------------- | :------------------------------- | :----------------------------------------------------------- |
4747
| **Core Purpose** | Blank slate | Quick start, basic structure | Quality, consistency, efficiency |
4848
| **Linting (e.g., ESLint)** | ❌ No | ⚙️ Manual setup required / Basic | ✅ Pre-configured, opinionated |
@@ -133,27 +133,27 @@ This template is built around a fully automated, commit-driven workflow.
133133

134134
This project uses `Husky`, `lint-staged`, and `commitlint` to enforce code quality and consistent commit messages.
135135

136-
1. **On Staging:** When you stage files (`git add`), `lint-staged` runs formatters (`Prettier`) and linters (`ESLint`, `markdownlint`) on them. This ensures your code and documentation are clean _before_ you even write a commit message.
137-
2. **On Commit:** When you write a commit message (`git commit`), `commitlint` validates it against the **Conventional Commits** specification. This is the most critical step, as these structured commit messages power the automated release process. If your message is not compliant (e.g., `git commit -m "updated stuff"`), the commit will be aborted.
136+
1. **On Staging:** When you stage files (`git add`), `lint-staged` runs formatters (`Prettier`) and linters (`ESLint`, `markdownlint`) on them. This ensures your code and documentation are clean _before_ you even write a commit message.
137+
2. **On Commit:** When you write a commit message (`git commit`), `commitlint` validates it against the **Conventional Commits** specification. This is the most critical step, as these structured commit messages power the automated release process. If your message is not compliant (e.g., `git commit -m "updated stuff"`), the commit will be aborted.
138138

139139
### Automated Release Generation
140140

141141
This template uses **`semantic-release`** to automate the entire release process. The manual step of deciding on a version number and creating a release is completely removed.
142142

143143
The process is triggered every time a commit is merged into the `main` branch. Here’s what happens:
144144

145-
1. **Trigger:** A push or merge to the `main` branch starts the `release.yml` GitHub Actions workflow.
146-
2. **Analysis:** `semantic-release` analyzes the commit messages since the last release.
147-
3. **Versioning:** It automatically determines the next version number based on the types of commits:
148-
* `fix:` commits result in a **PATCH** release (e.g., `1.0.0` -> `1.0.1`).
149-
* `feat:` commits result in a **MINOR** release (e.g., `1.0.1` -> `1.1.0`).
150-
* Commits with `BREAKING CHANGE:` in the body result in a **MAJOR** release (e.g., `1.1.0` -> `2.0.0`).
151-
4. **Release Generation:** If a release is warranted, `semantic-release` performs the following actions:
152-
* Updates `CHANGELOG.md` with the new release notes.
153-
* Updates the `version` in `package.json`.
154-
* Creates a new Git tag for the new version.
155-
* Creates a new GitHub Release with the generated notes.
156-
* Commits the updated `package.json` and `CHANGELOG.md` files back to the `main` branch.
145+
1. **Trigger:** A push or merge to the `main` branch starts the `release.yml` GitHub Actions workflow.
146+
2. **Analysis:** `semantic-release` analyzes the commit messages since the last release.
147+
3. **Versioning:** It automatically determines the next version number based on the types of commits:
148+
- `fix:` commits result in a **PATCH** release (e.g., `1.0.0` -> `1.0.1`).
149+
- `feat:` commits result in a **MINOR** release (e.g., `1.0.1` -> `1.1.0`).
150+
- Commits with `BREAKING CHANGE:` in the body result in a **MAJOR** release (e.g., `1.1.0` -> `2.0.0`).
151+
4. **Release Generation:** If a release is warranted, `semantic-release` performs the following actions:
152+
- Updates `CHANGELOG.md` with the new release notes.
153+
- Updates the `version` in `package.json`.
154+
- Creates a new Git tag for the new version.
155+
- Creates a new GitHub Release with the generated notes.
156+
- Commits the updated `package.json` and `CHANGELOG.md` files back to the `main` branch.
157157

158158
This means you no longer need to manually tag versions. Your release cycle is tied directly to the features and fixes you merge into your main branch.
159159

0 commit comments

Comments
 (0)