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
68 changes: 68 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Branch Strategy

## Branches

| Branch | Purpose |
|--------|---------|
| `main` | Production-ready code. Always stable. |
| `dev` | Development branch. All features merge here first. |
| `feature/*` | New features (e.g., `feature/login-page`) |
| `fix/*` | Bug fixes (e.g., `fix/navbar-bug`) |
| `hotfix/*` | Urgent fixes for production |

---

## Workflow

### 1. Start a new feature

```bash
git checkout dev
git pull origin dev
git checkout -b feature/your-feature-name
```

### 2. Work on your feature

Make changes, commit often:

```bash
git add .
git commit -m "feat: add login form"
```

### 3. Push and create Pull Request

```bash
git push origin feature/your-feature-name
```

Then create a PR to merge into `dev` (not `main`).

### 4. After review, merge to dev

Once approved, merge to `dev`. Delete the feature branch.

### 5. Release to main

When `dev` is stable and tested, create a PR from `dev` → `main`.

---

## Naming Conventions

| Type | Format | Example |
|------|--------|---------|
| Feature | `feature/short-description` | `feature/wallet-connect` |
| Bug fix | `fix/short-description` | `fix/header-alignment` |
| Hotfix | `hotfix/short-description` | `hotfix/login-crash` |
| Docs | `docs/short-description` | `docs/update-readme` |

---

## Rules

- Never push directly to `main`
- Always create PR for code review
- Keep commits small and descriptive
- Delete branches after merging
4 changes: 2 additions & 2 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
"jsx": "preserve",
"incremental": true,
"plugins": [
{
Expand All @@ -40,4 +40,4 @@
"node_modules",
"Sidexmockup_ref"
]
}
}