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
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,24 @@ bash scripts/up_stack.sh
bash scripts/verify_platform.sh
```

## Branch Strategy

- `main` is the stable release branch.
- `dev` is the integration branch for active development.
- Open pull requests against `dev`, not `main`.
- Do not push feature work directly to `main`.

Recommended flow:

```bash
git fetch origin
git switch dev
git pull --rebase origin dev
git switch -c feat/<short-topic>
```

If you are contributing from a fork, open your PR from `feat/<short-topic>` into `icaro-lab/MASE:dev`.

## Main Contribution Paths

### New Environment
Expand Down Expand Up @@ -75,9 +93,11 @@ bash scripts/verify_platform.sh
## Pull Requests

- Keep PRs scoped.
- Base PRs on `dev`.
- Describe the user-facing change clearly.
- Include the commands you ran.
- Call out any deferred work explicitly.
- Rebase or merge from `origin/dev` before marking the PR ready.

## Design Rules

Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,11 @@ This repo now includes:
- [SECURITY.md](SECURITY.md)
- GitHub CI under `.github/workflows/ci.yml`

Contribution flow:

- `main` stays stable
- contributions should branch from `dev` and open PRs back into `dev`

## Repository Shape

```text
Expand Down
Loading