Skip to content

Commit 868e773

Browse files
committed
📝 docs(changelog): standardize format to Keep a Changelog
Refactors the CHANGELOG.md to conform to the "Keep a Changelog" standard, improving its readability, consistency, and adherence to community best practices. Key changes include: - Consolidated non-standard categories (e.g., Chore, Build, Test, CI) into the standard categories (Added, Changed, Fixed, Removed, Security). - Removed gitmoji prefixes from all entries for a cleaner, more uniform appearance. - Rephrased several entries for better clarity and consistency.
1 parent 762ef2a commit 868e773

File tree

1 file changed

+30
-32
lines changed

1 file changed

+30
-32
lines changed

CHANGELOG.md

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,18 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88
## [0.3.0] - 2025-10-15
99

1010
### Added
1111
- Introduced `dateFormatterFactory` to reduce code duplication.
12+
- Added unit tests for `dateFormatterFactory`.
1213

1314
### Changed
1415
- Updated numerous development dependencies to their latest versions.
1516

16-
### Test
17-
- Added unit tests for `dateFormatterFactory`.
18-
1917
### Documentation
2018
- Improved README with Quick Start and professional restructure.
2119
- Updated usage and development guides for `dateFormatterFactory`.
@@ -31,13 +29,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3129
- Improved build process and configuration.
3230
- Grouped dependabot updates for npm and GitHub Actions.
3331
- Updated numerous development dependencies to their latest versions.
32+
- Implemented a new GitHub Actions workflow for continuous integration to improve code quality.
3433

3534
### Removed
3635
- Removed the unused `subtractYears` function from the codebase.
3736

38-
### CI
39-
- Implemented a new GitHub Actions workflow for continuous integration to improve code quality.
40-
4137
### Documentation
4238
- Added comprehensive `usage.md` and `development.md` guides.
4339
- Expanded `GEMINI.md` with more details on gitmoji conventions.
@@ -55,48 +51,50 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5551

5652
## [0.2.1] - 2025-08-20
5753

58-
### Fixed
59-
- ➖ chore(deps): remove gas-mock-globals to resolve security vulnerability in `lodash.set`.
54+
### Removed
55+
- Removed `gas-mock-globals` to resolve a security vulnerability in `lodash.set`.
6056

6157
### Changed
62-
- 🚚 chore(testing): move test file from `src/` to `test/` directory for better project structure.
58+
- Moved test file from `src/` to `test/` directory for better project structure.
6359

6460
## [0.2.0] - 2025-08-20
6561

6662
### Added
67-
- ✨ feat: add `mode` option to process emails as plain text or HTML
68-
- ✨ feat: implement testing and refactor core logic
69-
- 🔧 chore: Add build process for examples with exclusion
70-
- 🔧 chore(deps): add and configure ESLint and Prettier
71-
- 💚 ci(github): create dependabot.yml
72-
- Create FUNDING.yml
63+
- Add `mode` option to process emails as plain text or HTML.
64+
- Implement testing and refactor core logic.
65+
- Add build process for examples with exclusion.
66+
- Add and configure ESLint and Prettier.
67+
- Create `dependabot.yml` for CI.
68+
- Create `FUNDING.yml`.
7369

7470
### Fixed
75-
- 🔒️ fix: sanitize `<script>` tags from HTML using regex in `findMessages`
76-
- 🐛 fix: handle undefined mode in `findMessages`
77-
- 🐛 fix(examples): update queries for `removeAffiliatesOne` and `removeMoneyHeroInfo`
78-
- 🐛 fix(eslint): resolve all linting errors
71+
- Handle undefined mode in `findMessages`.
72+
- Update queries for `removeAffiliatesOne` and `removeMoneyHeroInfo` examples.
73+
- Resolve all linting errors.
74+
75+
### Security
76+
- Sanitize `<script>` tags from HTML using regex in `findMessages`.
7977

8078
### Changed
81-
- 💡 refactor(examples): simplify query for `removeNamecheapAffiliateInfo`
82-
- build(deps-dev): Bump @types/google-apps-script from 1.0.78 to 1.0.99
83-
- build(deps-dev): Bump @google/clasp from 2.4.2 to 2.5.0
84-
- build(deps-dev): Bump braces from 3.0.2 to 3.0.3
79+
- Simplify query for `removeNamecheapAffiliateInfo` example.
80+
- Bump `@types/google-apps-script` from 1.0.78 to 1.0.99.
81+
- Bump `@google/clasp` from 2.4.2 to 2.5.0.
82+
- Bump `braces` from 3.0.2 to 3.0.3.
8583

8684
### Documentation
87-
- 📝 docs: update `README.md` with `mode` option
88-
- 📝 docs: update development guidelines
89-
- 📝 docs: update documentation and project files
85+
- Update `README.md` with `mode` option.
86+
- Update development guidelines.
87+
- Update documentation and project files.
9088

9189
## [0.1.0] - 2024-03-12
9290

9391
### Added
94-
- ✨ feat: add example for GitHub Dependabot alerts
95-
- 🎉 Initial commit
92+
- Add example for GitHub Dependabot alerts.
93+
- Initial commit.
9694

9795
### Changed
98-
- 💡 refactor: comment regex patterns in `examples.js`
96+
- Comment regex patterns in `examples.js`.
9997

10098
### Documentation
101-
- 📄 docs: create code of conduct
102-
- 📝 docs: add author's website URL to `package.json`
99+
- Create code of conduct.
100+
- Add author's website URL to `package.json`.

0 commit comments

Comments
 (0)