1
0
mirror of https://github.com/axzilla/templui.git synced 2025-02-21 00:12:48 +00:00

change: update cheatsheet

This commit is contained in:
“axzilla” 2024-10-09 11:37:45 +02:00
parent e67be5a347
commit abfb645eec

View File

@ -1,11 +1,9 @@
# Goilerplate Commit & Changelog Cheatsheet
# Goilerplate Commit & Release Cheatsheet
## Commit Message Format
`<type>`: `<description>`
[optional body]
## Types
- `feat`: New feature or component
@ -19,32 +17,79 @@
## Examples
- `feat: add new Button component`
- `feat: add Button component`
- `fix: correct Card component padding on mobile`
- `docs: update README with Button component usage`
- `style: improve Input component layout`
- `refactor: simplify Modal component logic`
- `perf: optimize Table component rendering`
- `test: add unit tests for Dropdown component`
- `chore: update Tailwind CSS dependency`
## Breaking Changes
Add `!` after the type/scope for breaking changes:
Add `!` after the type for breaking changes:
- `feat!: redesign Form component API`
## Changelog
## Versioning Strategy (0.x.y)
Update the CHANGELOG.md file with each significant change. Group changes under the current date:
- 0: Remains 0 until the first stable version (1.0.0)
- x: For major changes or feature sets (e.g., 20)
- y: For minor changes, bugfixes, and incremental updates
```markdown
# Changelog
## Version Increments
## 2024-10-05
- Increase second number (x) for:
- New major features
- Significant API or functionality changes
- Increase third number (y) for:
- Bugfixes
- Small feature additions
- Documentation changes
- Performance optimizations
- Other minor changes
- Added: New features or components added
- Added: Some more features or components added
- Changed: Changes in existing functionality
- Fixed: Any bug fixes
```
## Release Process
1. Commit changes:
```
git add .
git commit -m "feat: implement XYZ feature"
```
2. Tag and push version:
```
git tag -a v0.20.2 -m "Release v0.20.2"
git push origin main --tags
```
3. Create GitHub Release:
- Go to GitHub > Releases > "Draft a new release"
- Select the created tag
- Title: "Release v0.20.2"
- Description: Brief summary of main changes
- Publish the release
## Go Module Usage
- Install latest version:
```
go get github.com/axzilla/goilerplate@latest
```
- Install specific version:
```
go get github.com/axzilla/goilerplate@v0.20.2
```
- Install development version:
```
go get github.com/axzilla/goilerplate@main
```
Remind users to run `go mod tidy` after changes.
## Transition to 1.0.0
Switch to 1.0.0 when the project:
- Has a stable API
- Is sufficiently tested
- Is ready for production environments
- Offers a solid feature base