Use this checklist before releasing a new version of CeriousScroll.

• All tests passing: npm test
• No TypeScript errors: npm run compile
• Code follows style guidelines
• All TODO comments addressed or documented
• No console.log or debug code in production files
• Performance benchmarks run and verified

• README.md updated with new features
• CHANGELOG.md updated with all changes
• API documentation updated (if API changed)
• IMPLEMENTATION_GUIDE.md updated (if needed)
• ARCHITECTURE.md updated (if architectural changes)
• Code examples tested and working
• Demos updated to showcase new features

• Version bumped in package.json (following semver)
• Version matches in CHANGELOG.md
• Release notes drafted
• Breaking changes documented (if major version)
• Migration guide written (if major version)

• Clean build: rm -rf dist && npm run build
• Built files verified in dist/ directory:
  • cerious-scroll.js (ES module)
  • cerious-scroll.d.ts (TypeScript definitions)
  • cerious-scroll.bundle.js (IIFE bundle)
  • cerious-scroll.min.js (Minified)
  • cerious-scroll.obfuscated.js (Obfuscated)
  • Source maps present
• File sizes reasonable (no unexpected bloat)
• Minified version works in browsers
• No sensitive information in built files

• All unit tests passing
• Test coverage adequate (>80%)
• Edge cases covered

• All integration tests passing
• Framework integrations tested (Vue, Angular)

• Chrome (latest)
• Firefox (latest)
• Safari (latest)
• Edge (latest)
• Mobile Safari (iOS)
• Chrome Mobile (Android)

• All demos load without errors
• Scrolling smooth in all demos
• No console errors in demos
• Performance acceptable in all demos

• License files up to date (LICENSE, LICENSE-MIT)
• Copyright year current in all files
• No license violations in dependencies: npm audit

• Dependencies up to date: npm outdated
• Security vulnerabilities checked: npm audit
• No unnecessary dependencies
• Peer dependencies documented
• DevDependencies separated from dependencies

• package.json fields complete:
  • name, version, description
  • main, module, types fields correct
  • keywords relevant
  • repository URL correct
  • bugs URL correct
  • homepage URL correct
  • license correct
  • author information correct
• .npmignore configured correctly
• Files array in package.json correct

• All changes committed
• Working directory clean: git status
• On correct branch (usually main)
• Branch up to date: git pull origin main
• GitHub Issues addressed or documented
• Pull requests merged

git checkout -b release/v1.0.0

# Update version in package.json
npm version <major|minor|patch> --no-git-tag-version

# Update CHANGELOG.md with release date
# Update any version references in documentation

# Clean install
rm -rf node_modules package-lock.json
npm install

# Run all checks
npm test
npm run build

# Verify built files
ls -lh dist/

git add .
git commit -m "chore: release v1.0.0"
git push origin release/v1.0.0

• Create PR to main branch
• Get approval from maintainer(s)
• Merge to main

git checkout main
git pull origin main
git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0

1. Go to GitHub repository
2. Click "Releases" → "Draft a new release"
3. Select the tag (v1.0.0)
4. Release title: "CeriousScroll v1.0.0"
5. Copy release notes from CHANGELOG.md
6. Attach built files (optional):
   • cerious-scroll.min.js
   • cerious-scroll.obfuscated.js
7. Mark as pre-release if applicable
8. Publish release

# Login to npm (if not already)
npm login

# Dry run to verify what will be published
npm publish --dry-run

# Publish to npm
npm publish

# For pre-release versions:
npm publish --tag beta

# Install from npm in a test project
mkdir test-install
cd test-install
npm init -y
npm install @ceriousdevtech/cerious-scroll

# Verify files are correct
ls node_modules/@ceriousdevtech/cerious-scroll/

# If using GitHub Pages, push will auto-deploy
git push origin main

# Verify site updates at:
# https://ceriousdevtech.github.io/cerious-scroll/

• Tweet announcement (if applicable)
• Post on relevant forums/communities
• Update company website
• LinkedIn post (if applicable)

• Verify npm package is available: npm view @ceriousdevtech/cerious-scroll
• Test installation in clean project
• Monitor for immediate issues
• Respond to any urgent bug reports

• Check download stats on npm
• Monitor GitHub issues for problems
• Update internal documentation

• Review community feedback
• Address any critical bugs with patch release
• Update project roadmap
• Plan next release

If critical issues are discovered after release:

# Create hotfix branch
git checkout -b hotfix/v1.0.1 v1.0.0

# Fix the issue
# ... make changes ...

# Release patch version
npm version patch
git commit -am "fix: critical bug in xxx"
git push origin hotfix/v1.0.1

# Merge to main and tag
git checkout main
git merge hotfix/v1.0.1
git tag v1.0.1
git push origin main --tags

# Publish patch
npm publish

# Deprecate problematic version
npm deprecate @ceriousdevtech/[email protected] "Critical bug, please upgrade to 1.0.1"

# Last resort - only if absolutely necessary
npm unpublish @ceriousdevtech/[email protected]

• Major (X.0.0): Breaking changes
• Minor (0.X.0): New features, backwards compatible
• Patch (0.0.X): Bug fixes, backwards compatible

• Alpha: 1.0.0-alpha.1 - Early testing, unstable
• Beta: 1.0.0-beta.1 - Feature complete, testing phase
• RC: 1.0.0-rc.1 - Release candidate, final testing

If issues arise during release:

Primary Contact: [email protected]
Emergency: Jared Kirchgatter

• Always test in production-like environment before release
• Keep communication transparent with users
• Document any deviations from this checklist
• Update this checklist as process evolves

Last Updated: 2026-01-28
Version: 1.0.0

Copyright © 2024-2026 Cerious DevTech LLC. All rights reserved.