|
51 | 51 | [](#readme-top) |
52 | 52 |
|
53 | 53 | </div> |
54 | | - |
55 | | -# Changelog |
56 | | - |
57 | | -All notable changes to this project will be documented in this file. |
58 | | - |
59 | | -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
60 | | -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
61 | | - |
62 | | -## \[Unreleased] |
63 | | - |
64 | | -### Added |
65 | | - |
66 | | -- Initial library template structure |
67 | | -- TypeScript configuration with modern settings |
68 | | -- Comprehensive testing setup with Vitest |
69 | | -- Build configuration with tsup |
70 | | -- Linting and formatting setup |
71 | | -- Example usage and documentation |
72 | | -- Utility functions for common operations |
73 | | -- Type-safe configuration management |
74 | | -- Async data processing capabilities |
75 | | -- Data validation utilities |
76 | | - |
77 | | -### Changed |
78 | | - |
79 | | -- Updated project description and documentation |
80 | | -- Enhanced README with comprehensive API reference |
81 | | -- Improved development workflow scripts |
82 | | - |
83 | | -### Fixed |
84 | | - |
85 | | -- N/A |
86 | | - |
87 | | -### Removed |
88 | | - |
89 | | -- N/A |
90 | | - |
91 | | -## \[1.0.0] - 2025-01-XX |
92 | | - |
93 | | -### Added |
94 | | - |
95 | | -- Initial release of LobeHub Library Template |
96 | | -- Core `LobeLib` class with configuration management |
97 | | -- Utility functions: `formatVersion`, `validateConfig`, `createDefaultConfig` |
98 | | -- TypeScript type definitions |
99 | | -- Comprehensive test suite |
100 | | -- Modern build pipeline |
101 | | -- Development tooling setup |
102 | | - |
103 | | ---- |
104 | | - |
105 | | -## Template Usage |
106 | | - |
107 | | -When using this template for your own library, follow these guidelines: |
108 | | - |
109 | | -### Adding Entries |
110 | | - |
111 | | -For each version, add entries under the appropriate section: |
112 | | - |
113 | | -- **Added** for new features |
114 | | -- **Changed** for changes in existing functionality |
115 | | -- **Deprecated** for soon-to-be removed features |
116 | | -- **Removed** for now removed features |
117 | | -- **Fixed** for any bug fixes |
118 | | -- **Security** in case of vulnerabilities |
119 | | - |
120 | | -### Version Format |
121 | | - |
122 | | -Use semantic versioning: |
123 | | - |
124 | | -- **Major** version for incompatible API changes |
125 | | -- **Minor** version for added functionality in a backwards compatible manner |
126 | | -- **Patch** version for backwards compatible bug fixes |
127 | | - |
128 | | -### Example Entry |
129 | | - |
130 | | -```markdown |
131 | | -## [1.1.0] - 2025-01-15 |
132 | | - |
133 | | -### Added |
134 | | - |
135 | | -- New `processData` method for async data processing |
136 | | -- Support for custom timeout configuration |
137 | | - |
138 | | -### Changed |
139 | | - |
140 | | -- Improved error handling in `validateData` method |
141 | | -- Updated TypeScript configuration for better type inference |
142 | | - |
143 | | -### Fixed |
144 | | - |
145 | | -- Fixed issue with empty string validation |
146 | | -- Resolved timeout not being applied correctly |
147 | | -``` |
0 commit comments