Skip to content

Commit 339a895

Browse files
committed
Update CHANGELOG for v1.0.0 release
Comprehensive changelog for initial stable release including: - All core features organized by category - Recent improvements and enhancements - Technical details and known limitations
1 parent 9cab1f7 commit 339a895

1 file changed

Lines changed: 126 additions & 43 deletions

File tree

CHANGELOG.md

Lines changed: 126 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -7,53 +7,136 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [1.0.0] - 2025-11-18
99

10-
### Added
10+
**Initial stable release** of GitHub Devwatch - A Chrome extension for monitoring GitHub repository activity across multiple repos with real-time notifications.
11+
12+
### Core Features
13+
14+
**Repository Monitoring**
1115
- Multi-repository monitoring with GitHub API integration
12-
- Browser notifications for new PRs, issues, and releases
13-
- Badge counter on extension icon showing unread activity count
14-
- Activity filtering by type (PRs, Issues, Releases)
15-
- Configurable check intervals (5, 15, 30, 60 minutes)
16-
- Search functionality for filtering activities
17-
- Archive view for viewing read activities
18-
- Repository mute and snooze controls for managing notifications
19-
- Collapsible repository sections in activity list
20-
- Bulk import for watched, starred, and participating repositories
21-
- Settings backup and restore functionality
16+
- Support for watching unlimited repositories (within GitHub API rate limits)
17+
- Parallel repository fetching for improved performance
18+
- Automatic activity polling with configurable intervals (5, 15, 30, 60 minutes)
19+
- Activity filtering by type (Pull Requests, Issues, Releases)
20+
- Real-time badge counter showing unread activity count
21+
- Browser notifications for new activity (configurable per-repo)
22+
- Repository pinning to keep important repos at the top
23+
- Repository mute and snooze controls for temporary notification silencing
24+
- Optional mark-as-read when snoozing repositories
25+
- Bulk import from GitHub (watched, starred, and participating repos)
26+
27+
**User Interface**
28+
- Clean, modern popup interface with activity feed
29+
- Collapsible repository sections for better organization
30+
- Search and filter functionality for activities
31+
- Archive view for viewing previously read activities
32+
- Onboarding wizard for first-time setup
2233
- Dark mode, light mode, and system theme support
23-
- Notification toggle for browser notifications
24-
- Offline support with cached activity data
25-
- Accessibility features including keyboard navigation and ARIA labels
26-
- Security hardening with XSS protection and input sanitization
27-
- Content Security Policy implementation
28-
- Modern UI with hover effects and visual feedback
29-
- Shared utility modules for better code organization
30-
- Comprehensive test suite with Jest
31-
- GitHub Actions CI/CD pipeline
32-
- ESLint and Prettier configuration
33-
- Build validation script
34-
35-
### Changed
36-
- Renamed extension to "GitHub Devwatch"
37-
- Updated extension icon to git branch design
38-
- Redesigned settings page with modern tabbed UI
39-
- Refactored code into modular shared utilities
40-
- Switched to SVG icons throughout the UI
41-
- Moved toast notifications to bottom-right corner
42-
- Replaced mute toggle with eye icon for better UX
43-
- Improved import UI with better visual hierarchy
44-
45-
### Fixed
46-
- Jest configuration and test syntax errors
47-
- ESLint errors in build scripts
48-
- Module exports and imports
49-
- Unused imports cleaned up
50-
- Test suite re-enabled for accessibility tests
51-
52-
### Security
34+
- Responsive design with mobile-friendly layout
35+
- Custom scrollbar styling for better aesthetics
36+
- Toast notifications for user feedback
37+
- Keyboard navigation support throughout the UI
38+
39+
**Settings & Configuration**
40+
- Redesigned options page with tabbed navigation (Setup, Repositories, Settings, Help)
41+
- Token input integrated into setup wizard
42+
- Repository management with visual cards and action buttons
43+
- Activity type filters (enable/disable PRs, Issues, Releases)
44+
- Configurable item expiry (auto-hide old activities)
45+
- Settings backup and restore functionality
46+
- GitHub token import from multiple sources
47+
- Enhanced help documentation with changelog viewer
48+
49+
**Security & Privacy**
50+
- AES-256 encrypted token storage with session caching
51+
- Automatic token migration from unencrypted to encrypted storage
52+
- Content Security Policy to prevent script injection
5353
- XSS protection through input sanitization
5454
- URL validation to prevent malicious redirects
55-
- Content Security Policy to prevent script injection
56-
- Secure token storage using Chrome's local storage
55+
- Repository name validation against GitHub's format
56+
- No third-party services or analytics
57+
- All data stored locally on user's device
58+
59+
**Developer Experience**
60+
- MVC architecture with modular code organization
61+
- Shared utility modules for better maintainability
62+
- Comprehensive test suite with Jest (316+ tests)
63+
- GitHub Actions CI/CD pipeline with automated testing
64+
- Codecov integration for test coverage tracking
65+
- Automated CHANGELOG validation before releases
66+
- Dependabot for automated dependency updates
67+
- ESLint and Prettier for code quality
68+
- Pre-commit hooks for linting
69+
- Pre-push validation (lint, typecheck, test, build)
70+
- Build validation script for extension packaging
71+
- Chrome extension packaging script
72+
73+
**Accessibility**
74+
- WCAG 2.1 Level A compliance
75+
- Full keyboard navigation support
76+
- ARIA labels and roles throughout the UI
77+
- Screen reader friendly error messages
78+
- Focus indicators for interactive elements
79+
- Semantic HTML structure
80+
81+
### Recent Improvements
82+
83+
**Project Governance**
84+
- Added CODE_OF_CONDUCT.md for contributor guidelines
85+
- Added SECURITY.md with vulnerability reporting process and security measures
86+
87+
**CI/CD Enhancements**
88+
- Integrated Codecov for automated test coverage tracking
89+
- Added CHANGELOG validation in release workflow (blocks releases without changelog entries)
90+
- Enabled Dependabot for npm and GitHub Actions dependencies
91+
- Weekly dependency update schedule with grouped minor/patch updates
92+
- Added pre-commit hook for linting
93+
94+
**Documentation Updates**
95+
- Updated README with AES-256 encryption details and Codecov badge
96+
- Updated PRIVACY.md to reflect encrypted token storage
97+
- Added comprehensive release process documentation to CONTRIBUTING.md
98+
- Included version guidelines and CHANGELOG requirements for maintainers
99+
100+
**Code Quality**
101+
- Removed debug console.log statements across codebase
102+
- Cleaned up unused imports and variables
103+
- Fixed badge count to respect item expiry settings
104+
- Made updateLastUpdated async and use actual lastCheck timestamp
105+
- Various bug fixes and performance improvements
106+
107+
**UI/UX Improvements**
108+
- Redesigned options page with improved visual hierarchy
109+
- Moved token input into primary setup step card
110+
- Added repository section cards with icons and count badges
111+
- Improved mobile responsiveness throughout settings
112+
- Added changelog viewer to help section
113+
- Enhanced scrollbar styling in popup
114+
- Added hover effects and animations for better feedback
115+
116+
**Testing**
117+
- Added test coverage for activity-item-view component
118+
- Added test coverage for repository-validator
119+
- Updated and improved existing test suites
120+
- Achieved 58% overall test coverage
121+
122+
### Technical Details
123+
124+
- **Manifest Version:** 3 (Chrome Extension Manifest V3)
125+
- **Framework:** Vanilla JavaScript (no external dependencies for core functionality)
126+
- **Architecture:** Model-View-Controller (MVC) pattern
127+
- **Storage:** Chrome Storage API (sync for settings, local for activity data)
128+
- **API:** GitHub REST API v3
129+
- **Testing:** Jest with jsdom
130+
- **Build Tools:** Node.js build scripts
131+
- **Supported Browsers:** Chrome, Edge, and other Chromium-based browsers
132+
133+
### Known Limitations
134+
135+
- GitHub API rate limit: 5,000 requests/hour for authenticated users
136+
- Extension uses ~1-3 API requests per repository per check
137+
- Recommended check interval: 15+ minutes for multiple repos
138+
- Maximum sync storage: 100KB (used for settings)
139+
- Maximum local storage: 5MB+ (used for activity history)
57140

58141
---
59142

0 commit comments

Comments
 (0)