Skip to content

Commit fb5c0c0

Browse files
committed
changes
1 parent 58317e5 commit fb5c0c0

20 files changed

+1371
-321
lines changed

.github/RELEASE_TEMPLATE.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Release Template
2+
3+
## Version [X.Y.Z] - Release Name (YYYY-MM-DD)
4+
5+
### 🚀 What's New
6+
7+
Brief description of the major features, improvements, or changes in this release.
8+
9+
---
10+
11+
### ✨ Features
12+
13+
- **Feature Name**: Description of the new feature and its benefits
14+
- **Another Feature**: What this feature does for users
15+
- **Enhancement**: Improvement to existing functionality
16+
17+
### 🐛 Bug Fixes
18+
19+
- Fixed issue where [describe the problem and solution]
20+
- Resolved bug causing [specific issue description]
21+
- Corrected [problem] that affected [functionality]
22+
23+
### 🔧 Improvements
24+
25+
- Improved performance of [specific component/feature]
26+
- Enhanced [functionality] for better user experience
27+
- Optimized [process/algorithm] resulting in [benefit]
28+
29+
### 📚 Documentation
30+
31+
- Updated README with new installation instructions
32+
- Added examples for [specific feature]
33+
- Improved API documentation for [endpoints/methods]
34+
35+
### 🔒 Security
36+
37+
- Fixed security vulnerability in [component]
38+
- Updated dependencies to address [security issue]
39+
- Enhanced [security feature] implementation
40+
41+
### ⚠️ Breaking Changes
42+
43+
**Important**: This release contains breaking changes that may affect your implementation.
44+
45+
- **Change 1**: Description of what changed and migration steps
46+
- **Change 2**: What users need to update in their code
47+
- **Deprecated**: [Feature/API] is now deprecated and will be removed in v[X.Y.Z]
48+
49+
### 📦 Dependencies
50+
51+
- Updated [dependency] from v[X.Y.Z] to v[A.B.C]
52+
- Added new dependency: [package-name] v[X.Y.Z]
53+
- Removed deprecated dependency: [package-name]
54+
55+
### 📊 Contributors
56+
- **Contributors**: Thanks to [@username1], [@username2], [@username3]
57+
58+
### 🙏 Acknowledgments
59+
60+
Special thanks to:
61+
- [@contributor1] for implementing [feature]
62+
- [@contributor2] for reporting and helping fix [bug]
63+
- Community members who provided feedback and testing
64+
65+
### 📋 Checksums
66+
67+
**Download Verification**:
68+
```
69+
SHA256: [checksum-here]
70+
MD5: [checksum-here]
71+
```
72+
## 📞 Support
73+
74+
- 📧 Email: [email protected]
75+
- 🐛 Issues: [Repo Issues](https://github.com/ukr-projects/repo-blueprint/issues)
76+
- 🔓 Security: [Repo Security](https://github.com/ukr-projects/repo-blueprint/security)
77+
- ⛏ Pull Request: [Repo Pull Request](https://github.com/ukr-projects/repo-blueprint/pulls)
78+
- 📖 Docs: [Repo Documentation](https://github.com/ukr-projects/repo-blueprint/tree/main/docs)
79+
- 📃 Changelog: [Repo Changelog](https://github.com/ukr-projects/repo-blueprint/docs/CHANGELOG.md)
80+
---
81+
82+
*This release source code was tested on: Windows, MacOS and Ubuntu*

CONTRIBUTING.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

README.md

Lines changed: 0 additions & 175 deletions
This file was deleted.
File renamed without changes.
784 KB
Loading

docs/CHANGELOG.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
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+
## [1.0.0] - 2025-07-25
9+
10+
### Added
11+
- 🎉 **Initial release** with core transcript extraction and AI modules
12+
- 🚀 Integrated both YouTube Transcript API and `yt-dlp` fallback
13+
- 🤖 Gemini AI features: summaries, key quotes, Q&A, study guides, flashcards, insights
14+
- 🔍 Interactive transcript viewer with search, copy, and notes
15+
- 💬 Chat interface to ask questions about the transcript
16+
17+
18+
### Security
19+
- Added SECURITY.md
20+
21+
---
22+
23+
## Guidelines for Contributors
24+
25+
When adding entries to this changelog:
26+
27+
1. **Group changes** by type using the categories above
28+
2. **Write for humans** - use clear, descriptive language
29+
3. **Include issue/PR numbers** when relevant: `Fixed login bug (#123)`
30+
4. **Date format** should be YYYY-MM-DD
31+
5. **Version format** should follow [Semantic Versioning](https://semver.org/)
32+
6. **Keep entries concise** but informative
33+
34+
### Version Number Guidelines
35+
- **Major** (X.y.z) - Breaking changes
36+
- **Minor** (x.Y.z) - New features, backwards compatible
37+
- **Patch** (x.y.Z) - Bug fixes, backwards compatible
38+
39+
### Example Entry Format
40+
```markdown
41+
## [1.2.3] - 2024-01-15
42+
43+
### Added
44+
- New feature description (#PR-number)
45+
46+
### Fixed
47+
- Bug fix description (fixes #issue-number)
48+
```

CODE_OF_CONDUCT.md renamed to docs/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Examples of unacceptable behavior include:
4040

4141
Community leaders are responsible for clarifying and enforcing our standards and
4242
will take appropriate and fair corrective action in response to any behavior that
43-
they deem inappropriate, threatening,offensive, or harmful.
43+
they deem inappropriate, threatening, offensive, or harmful.
4444

4545
Community leaders have the right and responsibility to remove, edit, or reject
4646
comments, commits, code, wiki edits, issues, and other contributions that are

0 commit comments

Comments
 (0)