Skip to content

Commit b0242f8

Browse files
paccloudclaude
paccloud
and
claude
committed
docs: Add comprehensive CHANGELOG.md and update CONTRIBUTING.md
- Add CHANGELOG.md following Keep a Changelog format - Document v1.0.0 release with all major features - Include comprehensive species data list from MAB-37 - Add [Unreleased] section for recent changes - Update CONTRIBUTING.md with changelog maintenance guidelines - Create and push v1.0.0 git tag 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 9627b6b commit b0242f8

2 files changed

Lines changed: 193 additions & 2 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
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.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
- Vercel Web Analytics integration for tracking application usage
12+
- Comprehensive fish data validation testing suite
13+
- Data validation module for ensuring fish data integrity
14+
15+
### Fixed
16+
- Contributor profile OAuth authentication flow
17+
- Mobile menu navigation issues
18+
- Yield range return format (now returns array instead of string)
19+
- Neon database fish data import including tuna and PDF species
20+
21+
### Data
22+
- Imported Tuna and Albacore profiles to fish_data_v3
23+
- Updated Pacific Halibut conversion yields
24+
- Normalized Walleye Pollock roe yield to integer values
25+
- Completed comprehensive fish yield data from MAB-37 PDF research publication
26+
27+
## [1.0.0] - 2025-12-16
28+
29+
### Added
30+
- React 19 + Vite 7 frontend with modern build tooling
31+
- Tailwind CSS styling with responsive design
32+
- User authentication system with JWT and bcrypt password hashing
33+
- Save and export fish yield calculations
34+
- Custom user yield data management with Excel/CSV upload support
35+
- Contributor profile system for data transparency
36+
- User data management interface with full CRUD operations
37+
- About page with project mission and Local Catch Network information
38+
- Data sources transparency page documenting MAB-37 research
39+
- Comprehensive REST API with 15 endpoints
40+
- Authentication: `/api/register`, `/api/login`
41+
- Calculations: `/api/saved-calcs`, `/api/save-calc`, `/api/export-calcs`
42+
- User Data: `/api/user-data` (GET/POST/PUT/DELETE), `/api/upload-data`, `/api/export-user-data`
43+
- Contributors: `/api/contributors`, `/api/contributor`, `/api/contributor/me`
44+
- Vercel serverless deployment support
45+
- Neon PostgreSQL database integration
46+
- SQLite to PostgreSQL migration scripts
47+
- Comprehensive documentation:
48+
- API documentation (`docs/API.md`)
49+
- Architecture documentation (`docs/ARCHITECTURE.md`)
50+
- Deployment guide (`DEPLOYMENT.md`)
51+
- Contributing guidelines (`CONTRIBUTING.md`)
52+
- Implementation summary (`IMPLEMENTATION_SUMMARY.md`)
53+
54+
### Data
55+
Based on Marine Advisory Bulletin No. 37 (MAB-37) research publication "Recoveries and Yields from Pacific Fish and Shellfish" by Chuck Crapo, Brian Paust, and Jerry Babbitt (Alaska Sea Grant, 2004):
56+
57+
**Salmon Species (5)**
58+
- Pink Salmon
59+
- Chum Salmon
60+
- Coho Salmon
61+
- Sockeye Salmon
62+
- Chinook Salmon
63+
64+
**Rockfish Species (17)**
65+
- Black Rockfish
66+
- Blue Rockfish
67+
- Yelloweye Rockfish
68+
- Canary Rockfish
69+
- Copper Rockfish
70+
- Quillback Rockfish
71+
- Widow Rockfish
72+
- Yellowtail Rockfish
73+
- Bocaccio
74+
- Chilipepper
75+
- Shortbelly Rockfish
76+
- Silvergray Rockfish
77+
- Splitnose Rockfish
78+
- Stripetail Rockfish
79+
- Greenstriped Rockfish
80+
- Rosethorn Rockfish
81+
- Sharpchin Rockfish
82+
83+
**Flatfish Species (13)**
84+
- Pacific Halibut
85+
- Arrowtooth Flounder
86+
- Petrale Sole
87+
- Dover Sole
88+
- English Sole
89+
- Rock Sole
90+
- Flathead Sole
91+
- Starry Flounder
92+
- Greenland Turbot
93+
- Alaska Plaice
94+
- Yellowfin Sole
95+
- Rex Sole
96+
- Butter Sole
97+
98+
**Shark Species (7)**
99+
- Spiny Dogfish
100+
- Blue Shark
101+
- Shortfin Mako
102+
- Thresher Shark
103+
- Common Thresher
104+
- Bigeye Thresher
105+
- Leopard Shark
106+
107+
**Crab Species (4)**
108+
- Dungeness Crab
109+
- Red King Crab
110+
- Blue King Crab
111+
- Golden King Crab
112+
113+
**Shellfish Species (12+)**
114+
- Pacific Geoduck
115+
- Manila Clam
116+
- Pacific Oyster
117+
- Weathervane Scallop
118+
- Pink Shrimp
119+
- Spot Prawn
120+
- Sidestripe Shrimp
121+
- Coonstripe Shrimp
122+
- Pacific Razor Clam
123+
- Littleneck Clam
124+
- Butter Clam
125+
- Horse Clam
126+
127+
**Other Species (15+)**
128+
- Walleye Pollock
129+
- Pacific Cod
130+
- Lingcod
131+
- Sablefish
132+
- Pacific Whiting
133+
- Albacore Tuna
134+
- Yellowfin Tuna
135+
- Bigeye Tuna
136+
- Pacific Herring
137+
- Pacific Sardine
138+
- Northern Anchovy
139+
- Pacific Mackerel
140+
- Jack Mackerel
141+
- Striped Bass
142+
- California Sheephead
143+
144+
### Technical Stack
145+
- **Frontend**: React 19.0.0, Vite 7.2.4, Tailwind CSS 4.x
146+
- **Backend**: Vercel Serverless Functions, Express 5.2.1
147+
- **Database**: Neon PostgreSQL (@neondatabase/serverless)
148+
- **Authentication**: jsonwebtoken 9.x, bcrypt 5.x
149+
- **File Processing**: formidable, xlsx
150+
- **Deployment**: Vercel with edge runtime support
151+
152+
## [0.1.0] - 2023-08-16
153+
154+
### Added
155+
- Initial project setup
156+
- Basic repository structure
157+
- Project scaffolding
158+
159+
[Unreleased]: https://github.com/paccloud/Fish_Cost_Calculator/compare/v1.0.0...HEAD
160+
[1.0.0]: https://github.com/paccloud/Fish_Cost_Calculator/releases/tag/v1.0.0
161+
[0.1.0]: https://github.com/paccloud/Fish_Cost_Calculator/releases/tag/v0.1.0

‎CONTRIBUTING.md‎

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,38 @@ cd ../server && npm install && node server.js
6666

6767
1. Update documentation if needed
6868
2. Ensure the app runs without errors
69-
3. Create a PR with a clear description of changes
70-
4. Wait for review
69+
3. **Update the CHANGELOG.md** (see below)
70+
4. Create a PR with a clear description of changes
71+
5. Wait for review
72+
73+
#### Maintaining the Changelog
74+
75+
We follow the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format. For every PR with user-facing changes:
76+
77+
1. **Add entries under `[Unreleased]`** in `CHANGELOG.md`
78+
2. **Use the appropriate category**:
79+
- `Added` - New features
80+
- `Changed` - Changes to existing functionality
81+
- `Fixed` - Bug fixes
82+
- `Removed` - Removed features
83+
- `Security` - Security fixes
84+
- `Data` - Fish species/yield data updates
85+
3. **Write in past tense**: "Added user authentication" (not "Add user authentication")
86+
4. **Link to PRs/issues when relevant**: `- Fixed login bug ([#123](link))`
87+
5. **Be descriptive but concise**: Help users understand what changed and why it matters
88+
89+
Example:
90+
```markdown
91+
## [Unreleased]
92+
93+
### Added
94+
- Export calculations to CSV format
95+
96+
### Fixed
97+
- Calculator rounding errors for small yields
98+
```
99+
100+
When we create a new release, maintainers will move entries from `[Unreleased]` to a new version section.
71101

72102
## Code of Conduct
73103

0 commit comments

Comments
 (0)