Merge pull request #4 from DesterLib/dev

feat:setup versioning

Author: AlkenD

.changeset/QUICK_REFERENCE.md

@@ -0,0 +1,155 @@
+# Changeset Quick Reference
+
+## Quick Commands
+
+```bash
+# Add a changeset for your changes
+pnpm changeset
+
+# Check what will be versioned
+pnpm changeset:status
+
+# Apply version bumps (maintainers only)
+pnpm version
+
+# Build and publish (maintainers only)
+pnpm release
+```
+
+## When to Use Each Bump Type
+
+### Patch (0.0.X) - Bug Fixes
+- 🐛 Bug fixes
+- 📝 Documentation
+- 🎨 Style/formatting
+- ♻️ Refactoring (no API change)
+- ⚡ Performance (no breaking change)
+
+**Example:**
+```
+🦋  Summary: Fix authentication token expiry bug
+🦋  Bump: patch
+```
+
+### Minor (0.X.0) - New Features
+- ✨ New features
+- 🔥 Deprecations
+- 🚀 Enhancements
+- 📦 New optional parameters
+
+**Example:**
+```
+🦋  Summary: Add user profile image upload endpoint
+🦋  Bump: minor
+```
+
+### Major (X.0.0) - Breaking Changes
+- 💥 Breaking API changes
+- ❌ Removed features
+- 🔄 Changed behavior
+- ⚠️ Required parameter changes
+
+**Example:**
+```
+🦋  Summary: Replace REST auth with OAuth2 (BREAKING)
+🦋  Bump: major
+```
+
+## Changeset Flow
+
+```mermaid
+graph LR
+    A[Make Changes] --> B[Create Changeset]
+    B --> C[Commit & Push]
+    C --> D[Create PR to dev]
+    D --> E[Review & Merge]
+    E --> F[Version Bump]
+    F --> G[Merge to main]
+    G --> H[Auto Release]
+```
+
+## Example Changeset File
+
+```markdown
+---
+"api": minor
+---
+
+Add WebSocket support for real-time notifications
+
+- New `/ws` endpoint for WebSocket connections
+- Real-time event streaming
+- Connection management utilities
+```
+
+## Commit Message Examples
+
+With `pnpm commit`:
+
+```bash
+# Feature
+feat(api): add user search endpoint
+
+# Bug fix
+fix(api): resolve JWT validation error
+
+# Breaking change
+feat(api)!: redesign authentication API
+
+BREAKING CHANGE: Replace /auth/login with OAuth2
+```
+
+## PR Workflow
+
+1. **Create feature branch from `dev`**
+   ```bash
+   git checkout dev && git pull
+   git checkout -b feat/my-feature
+   ```
+
+2. **Make changes and commit**
+   ```bash
+   git add .
+   pnpm commit
+   ```
+
+3. **Add changeset**
+   ```bash
+   pnpm changeset
+   git add .changeset
+   git commit -m "chore: add changeset"
+   ```
+
+4. **Push and create PR**
+   ```bash
+   git push -u origin feat/my-feature
+   ```
+
+5. **After merge to dev → version bump**
+   ```bash
+   pnpm version
+   git commit -am "chore: version packages"
+   ```
+
+6. **Merge to main → auto-release**
+
+## Tips
+
+✅ **DO**
+- Create changesets for user-facing changes
+- Write clear, descriptive summaries
+- One changeset per logical change
+- Review generated CHANGELOGs
+
+❌ **DON'T**
+- Skip changesets for features/fixes
+- Bundle multiple features in one changeset
+- Forget to commit the changeset file
+- Edit CHANGELOGs manually
+
+## Need Help?
+
+- 📖 [Full Documentation](../VERSIONING.md)
+- 🔗 [Changesets Docs](https://github.com/changesets/changesets)
+- 🔗 [Semantic Versioning](https://semver.org/)
+

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": [
+    "@changesets/changelog-github",
+    {
+      "repo": "DesterLib/desterlib"
+    }
+  ],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "dev",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/six-baths-thank.md

@@ -0,0 +1,26 @@
+---
+"docs": minor
+---
+
+Add comprehensive project documentation and community contribution guidelines
+
+New Documentation:
+
+- Contributing guide for external contributors with fork workflow
+- API overview with Swagger documentation links
+- Development guides (structure, versioning, commits, quick reference)
+- Installation and quick start guides
+
+Infrastructure:
+
+- AGPL-3.0 license for copyleft protection
+- Changesets for version management
+- GitHub Actions workflows for releases
+- PR template with changeset reminders
+
+Improvements:
+
+- Add DesterLib logo to docs navbar
+- Fix Swagger URL references (api/docs)
+- Remove web platform (not supported)
+- Add complete documentation site with Starlight