Skip to content

docs(workflow): add Git Flow and npm version requirements #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Zaiidmo merged 1 commit into from
Jan 31, 2026
Merged

docs(workflow): add Git Flow and npm version requirements #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
73 changes: 70 additions & 3 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,44 @@ Move to archive:
docs/tasks/archive/by-release/v2.0.0/MODULE-123-add-refresh-token.md
```

### Git Flow - Module Specific

**Branch Structure:**
- `master` - Production releases only
- `develop` - Active development
- `feature/MODULE-*` - New features
- `bugfix/MODULE-*` - Bug fixes

**Workflow:**
```bash
# 1. Stacca da develop
git checkout develop
git pull origin develop
git checkout -b feature/MODULE-123-add-refresh-token

# 2. Sviluppo
# ... implementa, testa, documenta ...

# 3. Bump version e push
npm version minor
git push origin feature/MODULE-123-add-refresh-token --tags

# 4. PR verso develop
gh pr create --base develop

# 5. Dopo merge in develop, per release:
git checkout master
git merge develop
git push origin master --tags
npm publish
```

**⚠️ IMPORTANTE:**
- ✅ Feature branch da `develop`
- ✅ PR verso `develop`
- ✅ `master` solo per release
- ❌ MAI PR dirette a `master`

### Development Workflow

**Simple changes** (bug fix, small improvements):
Expand Down Expand Up @@ -379,6 +417,22 @@ docs/tasks/archive/by-release/v2.0.0/MODULE-123-add-refresh-token.md
- Token expiration validation
```

### Version Bump Command
**ALWAYS run before pushing:**
```bash
npm version patch # Bug fixes (0.0.x)
npm version minor # New features (0.x.0)
npm version major # Breaking changes (x.0.0)

# This automatically:
# - Updates package.json version
# - Creates git commit "vX.X.X"
# - Creates git tag

# Then push:
git push && git push --tags
```

---

## 🚫 Restrictions - Require Approval
Expand Down Expand Up @@ -413,18 +467,31 @@ Before publishing:
- [ ] Breaking changes highlighted
- [ ] Integration tested with sample app

### Pre-Publish Hook (Recommended)

Aggiungi al `package.json` per bloccare pubblicazioni con errori:

```json
"scripts": {
"prepublishOnly": "npm run verify && npm run test:cov"
}
```

Questo esegue automaticamente tutti i controlli prima di `npm publish` e blocca se qualcosa fallisce.

---

## 🔄 Development Workflow

### Working on Module:
1. Clone module repo
2. Create branch: `feature/TASK-123-description`
2. Create branch: `feature/MODULE-123-description`
3. Implement with tests
4. Verify checklist
5. Update CHANGELOG
6. Bump version in package.json
7. Create PR
6. **Bump version**: `npm version patch` (or `minor`/`major`)
7. Push: `git push && git push --tags`
8. Create PR

### Testing in App:
```bash
Expand Down