chore: Add changelog and issue templates
- CHANGELOG.md: Keep a Changelog format, semantic versioning - Issue templates: bug report, feature request, MVP task - Ready for issue tracking on Gitea
This commit is contained in:
Claw
35
.gitea/ISSUE_TEMPLATE/bug_report.md
Normal file
35
.gitea/ISSUE_TEMPLATE/bug_report.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Report a bug or unexpected behavior
|
||||
labels: bug
|
||||
---
|
||||
|
||||
## Description
|
||||
A clear description of the bug.
|
||||
|
||||
## Steps to Reproduce
|
||||
1. Go to '...'
|
||||
2. Click on '...'
|
||||
3. Scroll down to '...'
|
||||
4. See error
|
||||
|
||||
## Expected Behavior
|
||||
What you expected to happen.
|
||||
|
||||
## Actual Behavior
|
||||
What actually happened.
|
||||
|
||||
## Screenshots
|
||||
If applicable, add screenshots to help explain the problem.
|
||||
|
||||
## Environment
|
||||
- **Device:** (e.g., iPhone 14, Desktop)
|
||||
- **OS:** (e.g., iOS 17, Ubuntu 24.04)
|
||||
- **Browser:** (e.g., Safari 17, Chrome 120)
|
||||
- **Pantry Version:** (e.g., v0.1.0)
|
||||
|
||||
## Additional Context
|
||||
Any other relevant information.
|
||||
|
||||
## Possible Solution
|
||||
(Optional) Suggest a fix or reason for the bug.
|
||||
24
.gitea/ISSUE_TEMPLATE/feature_request.md
Normal file
24
.gitea/ISSUE_TEMPLATE/feature_request.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest a new feature or enhancement
|
||||
labels: enhancement
|
||||
---
|
||||
|
||||
## Problem
|
||||
A clear description of the problem this feature would solve.
|
||||
(e.g., "I'm always frustrated when...")
|
||||
|
||||
## Proposed Solution
|
||||
Describe the solution you'd like to see.
|
||||
|
||||
## Alternatives Considered
|
||||
Describe any alternative solutions or features you've considered.
|
||||
|
||||
## Use Case
|
||||
How would you use this feature? Who else would benefit?
|
||||
|
||||
## Additional Context
|
||||
Add any other context, mockups, or screenshots about the feature request.
|
||||
|
||||
## Implementation Ideas
|
||||
(Optional) Any technical suggestions for how this could be implemented.
|
||||
32
.gitea/ISSUE_TEMPLATE/mvp_task.md
Normal file
32
.gitea/ISSUE_TEMPLATE/mvp_task.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
name: MVP Task
|
||||
about: Task for the MVP (v0.1) release
|
||||
labels: mvp, enhancement
|
||||
---
|
||||
|
||||
## Task Description
|
||||
Brief description of what needs to be done.
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Criterion 1
|
||||
- [ ] Criterion 2
|
||||
- [ ] Criterion 3
|
||||
|
||||
## Technical Details
|
||||
- **Related files/components:**
|
||||
- **Database changes:** (if any)
|
||||
- **Dependencies:** (other issues that must be completed first)
|
||||
|
||||
## Resources
|
||||
- Link to relevant documentation
|
||||
- Design mockups (if applicable)
|
||||
- API references
|
||||
|
||||
## Testing
|
||||
How should this be tested?
|
||||
|
||||
## Estimated Effort
|
||||
(e.g., 1 day, 3 days, 1 week)
|
||||
|
||||
## Notes
|
||||
Any additional context or considerations.
|
||||
84
CHANGELOG.md
Normal file
84
CHANGELOG.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Planning
|
||||
- Complete project documentation suite
|
||||
- 6-week MVP roadmap defined
|
||||
- Tech stack decisions locked in
|
||||
|
||||
---
|
||||
|
||||
## [0.1.0] - TBD
|
||||
|
||||
**MVP Release** - First usable version
|
||||
|
||||
### Added
|
||||
- PWA with offline support
|
||||
- Barcode scanning via camera
|
||||
- Open Food Facts integration
|
||||
- Tag-based inventory organization
|
||||
- Unit conversion system (metric defaults)
|
||||
- Multi-user authentication (email/password)
|
||||
- Basic CRUD for inventory items
|
||||
- Search and filter functionality
|
||||
|
||||
### Infrastructure
|
||||
- Nuxt 4 frontend
|
||||
- Supabase backend (self-hosted)
|
||||
- Docker Compose deployment
|
||||
- Coolify deployment guide
|
||||
|
||||
---
|
||||
|
||||
## [0.0.1] - 2026-02-08
|
||||
|
||||
### Added
|
||||
- Initial project structure
|
||||
- Comprehensive documentation:
|
||||
- README with project overview
|
||||
- PROJECT_PLAN with 6-week roadmap
|
||||
- ARCHITECTURE with system design
|
||||
- DATABASE schema and RLS policies
|
||||
- API reference for Supabase + Edge Functions
|
||||
- DEVELOPMENT setup and workflow guide
|
||||
- DEPLOYMENT guide for Docker + Coolify
|
||||
- MIT License
|
||||
- Organization and repository on Gitea
|
||||
|
||||
---
|
||||
|
||||
## Template for Future Releases
|
||||
|
||||
```markdown
|
||||
## [X.Y.Z] - YYYY-MM-DD
|
||||
|
||||
### Added
|
||||
- New features
|
||||
|
||||
### Changed
|
||||
- Changes in existing functionality
|
||||
|
||||
### Deprecated
|
||||
- Soon-to-be removed features
|
||||
|
||||
### Removed
|
||||
- Removed features
|
||||
|
||||
### Fixed
|
||||
- Bug fixes
|
||||
|
||||
### Security
|
||||
- Security improvements
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Unreleased]: https://gitea.jeanlucmakiola.de/pantry-app/pantry/compare/v0.0.1...HEAD
|
||||
[0.1.0]: https://gitea.jeanlucmakiola.de/pantry-app/pantry/releases/tag/v0.1.0
|
||||
[0.0.1]: https://gitea.jeanlucmakiola.de/pantry-app/pantry/releases/tag/v0.0.1
|
||||
Reference in New Issue
Block a user