Skip to content

Commit d9d51a4

Browse files
2 parents fd06492 + 5a4dacb commit d9d51a4

2 files changed

Lines changed: 105 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
- Project documentation (README, CONTRIBUTING, etc.)
12+
- Project structure and organization
13+
- Getting started guide
14+
- License file (MIT)
15+
16+
### Changed
17+
- Initial project setup
18+
19+
### Fixed
20+
- Initial project setup
21+
22+
### Deprecated
23+
- None yet
24+
25+
### Removed
26+
- None yet
27+
28+
### Security
29+
- None yet
30+
31+
---
32+
33+
## [0.1.0] - 2026-05-08
34+
35+
### Added
36+
- Initial project setup
37+
- Repository created on GitHub
38+
- Comprehensive documentation
39+
- Contribution guidelines
40+
- MIT License
41+
- Getting started guide
42+
- Project structure documentation
43+
- Standard Python development files (.gitignore, requirements.txt)
44+
45+
---
46+
47+
## How to Update This File
48+
49+
When making a release, follow this format:
50+
51+
```markdown
52+
## [Version] - YYYY-MM-DD
53+
54+
### Added
55+
- New features
56+
57+
### Changed
58+
- Changes to existing features
59+
60+
### Fixed
61+
- Bug fixes
62+
63+
### Deprecated
64+
- Soon-to-be removed features
65+
66+
### Removed
67+
- Removed features
68+
69+
### Security
70+
- Security vulnerability fixes
71+
```
72+
73+
### Guidelines
74+
75+
- Use [Semantic Versioning](https://semver.org/): MAJOR.MINOR.PATCH
76+
- Keep an `[Unreleased]` section for upcoming changes
77+
- Link versions to GitHub tags: `[0.1.0]: https://github.com/tailorgunjan93/KnowledgeBase/releases/tag/v0.1.0`
78+
- Categorize changes appropriately
79+
- Be concise and clear
80+
- Include references to issues/PRs when relevant
81+
82+
### Categories
83+
84+
- **Added** - New features
85+
- **Changed** - Changes in existing functionality
86+
- **Deprecated** - Soon-to-be removed features
87+
- **Removed** - Removed features
88+
- **Fixed** - Bug fixes
89+
- **Security** - Security vulnerability fixes
90+
91+
---
92+
93+
## Version History
94+
95+
| Version | Date | Description |
96+
|---------|------|-------------|
97+
| 0.1.0 | 2026-05-08 | Initial release |
98+
99+
---
100+
101+
For more information, see:
102+
- [Keep a Changelog](https://keepachangelog.com/)
103+
- [Semantic Versioning](https://semver.org/)

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ GROQ_API_KEY=your_groq_api_key
3535
### 3. Run Backend
3636

3737
```powershell
38-
python -m uvicorn backend.main:app --reload
38+
python -m uvicorn src.main:app --reload
3939
```
4040

4141
Backend runs at http://localhost:8000
@@ -81,4 +81,4 @@ pytest tests/ -v
8181

8282
## Architecture
8383

84-
See `architecture.md` for detailed documentation.
84+
See `architecture.md` for detailed documentation.

0 commit comments

Comments
 (0)