Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ coverage/
.cache/

# Package manager
package-lock.json
yarn.lock
pnpm-lock.yaml

Expand Down
15 changes: 13 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ All notable changes to PacificOceanAI will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Added README project signals, public usage transparency, and an Overleaf workflow visual.
- Added package metadata for repository URL, license, keywords, issues, and homepage.

### Changed
- Updated security reporting guidance to use GitHub private security advisories.
- Updated open-source readiness documentation to reflect AGPL-3.0 and version 3.3.7.
- Updated privacy policy contact links and third-party provider notes.

## [3.3.7] - 2026-03-16

### Fixed
Expand Down Expand Up @@ -103,7 +114,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

1. Update version in `package.json` and `manifest.config.ts`
2. Update CHANGELOG.md with changes
3. Commit changes: `git commit -m "chore: release v2.0.3"`
4. Create tag: `git tag v2.0.3`
3. Commit changes: `git commit -m "chore: release v3.3.7"`
4. Create tag: `git tag v3.3.7`
5. Push: `git push && git push --tags`
6. Create GitHub release with changelog
43 changes: 21 additions & 22 deletions OPEN_SOURCE_CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This checklist helps ensure your project is ready for open source release.
- Development setup
- Bilingual (English/Chinese)

- [x] **LICENSE** - MIT License
- [x] **LICENSE** - AGPL-3.0 License

- [x] **CONTRIBUTING.md** - Contribution guidelines
- Code of conduct reference
Expand Down Expand Up @@ -107,13 +107,12 @@ This checklist helps ensure your project is ready for open source release.

### Documentation

- [ ] **Update README.md**
- Replace placeholder URLs
- [x] **Update README.md**
- Add actual GitHub repository URL
- Update contact information
- Add screenshots/GIFs
- Add project signals and usage/distribution notes
- Add demo workflow visual

- [ ] **Update package.json**
- [x] **Update package.json**
- Set correct version
- Add repository URL
- Add homepage URL
Expand All @@ -125,18 +124,18 @@ This checklist helps ensure your project is ready for open source release.
- Check permissions
- Verify URLs

- [ ] **Update PRIVACY.md**
- [x] **Update PRIVACY.md**
- Replace placeholder GitHub URL
- Update contact information

- [ ] **Update SECURITY.md**
- Add security contact email
- Update GitHub username
- [x] **Update SECURITY.md**
- Add private security advisory link
- Update GitHub username and supported versions

### Legal

- [ ] **License verification**
- Ensure MIT license is appropriate
- [x] **License verification**
- Confirm AGPL-3.0 license is documented consistently
- Check third-party licenses
- Add license headers if needed

Expand All @@ -152,7 +151,7 @@ This checklist helps ensure your project is ready for open source release.
- [ ] **Create GitHub repository**
```bash
# On GitHub: Create new repository
# Name: pacific-ocean-ai
# Name: PacificOceanAI
# Description: AI-Powered Writing Assistant for Overleaf LaTeX Editor
# Public repository
```
Expand Down Expand Up @@ -230,8 +229,8 @@ This checklist helps ensure your project is ready for open source release.

- [ ] **Create Git tag**
```bash
git tag -a v2.0.3 -m "Release v2.0.3"
git push origin v2.0.3
git tag -a v3.3.7 -m "Release v3.3.7"
git push origin v3.3.7
```

- [ ] **GitHub Release**
Expand Down Expand Up @@ -286,10 +285,10 @@ npm run pack

# 3. Create release
git add .
git commit -m "chore: prepare for release v2.0.3"
git tag -a v2.0.3 -m "Release v2.0.3"
git commit -m "chore: prepare for release v3.3.7"
git tag -a v3.3.7 -m "Release v3.3.7"
git push origin main
git push origin v2.0.3
git push origin v3.3.7

# 4. GitHub will automatically create release via Actions
```
Expand All @@ -300,13 +299,13 @@ Before going public, replace these placeholders:

1. **README.md**
- `BigCatNotFat` → your GitHub username
- `your-email@example.com` → your email
- Ensure project links point to `BigCatNotFat/PacificOceanAI`

2. **PRIVACY.md**
- `YOUR_USERNAME` → your GitHub username
- Ensure project links point to `BigCatNotFat/PacificOceanAI`

3. **SECURITY.md**
- `your-email@example.com` → your email
- Use the private security advisory link
- `@BigCatNotFat` → your GitHub username

4. **package.json**
Expand All @@ -320,7 +319,7 @@ Before going public, replace these placeholders:
"url": "https://github.com/BigCatNotFat/PacificOceanAI/issues"
},
"homepage": "https://github.com/BigCatNotFat/PacificOceanAI#readme",
"author": "Your Name <your-email@example.com>"
"author": "BigCatNotFat"
}
```

Expand Down
Loading
Loading