Commit 0a096548 authored by Adrian Pino's avatar Adrian Pino
Browse files

Update README to provide more clarity

parent c20ad035
Loading
Loading
Loading
Loading
+23 −22
Original line number Diff line number Diff line
# OpenSDK - Contribution Guidelines
# OpenSDK

Thank you for contributing to this project! Please follow the guidelines below to ensure a smooth collaboration.
Open source SDK to abstract CAMARA/GSMA Transformation Functions (TFs) for Edge Cloud platforms & 5G network cores

## Branch Naming Convention
Each partner should create a feature branch following the naming convention based on the type of adapter they are contributing:
## Contributing Guidelines
Thank you for contributing to this project. Please follow the guidelines below to ensure a smooth collaboration.

### Directory Structure
Each contribution should be made in the appropriate directory:
- **EdgeCloud Adapters**`src/edgecloud/clients/`
- **Network Adapters**`src/network/clients/`

### Testing (Mandatory)
To merge a feature branch into `main`, the adapter **must pass the unit tests**. Instructions to do so available at [TESTING.md](docs/TESTING.md)

### Contributing
1. **Check Guidelines at [CONTRIBUTING.md](docs/CONTRIBUTING.md).**
2. **Create a New Branch** following the naming convention.
3. **Develop Your Feature** inside the correct directory.
4. **Ensure All Tests Pass**  before the merge.
5. **Submit a Merge Request (MR)** to the `main` branch.

### Branch Naming Convention
Each partner should create a feature branch following the naming convention based on the type of adapter they are contributing:

### ☁️ EdgeCloud Adapters
#### ☁️ EdgeCloud Adapters
Branch Name Format:
```
feature/add-edgecloud-<EDGE_CLOUD_PLATFORM_NAME>
@@ -16,7 +33,7 @@ Example:
feature/add-edgecloud-i2edge
```

### 🌐 Network Adapters
#### 🌐 Network Adapters
Branch Name Format:
```
feature/add-network-<5G_CORE_NAME>
@@ -26,22 +43,6 @@ Example:
feature/add-network-open5gs
```

## Directory Structure
Each contribution should be made in the appropriate directory:
- **EdgeCloud Adapters**`src/edgecloud/clients/`
- **Network Adapters**`src/network/clients/`

## Testing (Mandatory)
To merge a feature branch into `main`, the adapter **must pass the unit tests** under the `/tests` directory. Please use `/tests/edgecloud` for edgecloud, and `/tests/network` for the 5G cores). Instructions to do so available at [TESTING.md](docs/TESTING.MD)

## Contributing
1. **Check Guidelines at [CONTRIBUTING.md](docs/CONTRIBUTING.md).**
2. **Create a New Branch** following the naming convention.
3. **Develop Your Feature** inside the correct directory.
4. **Satisfy Unit Tests** located under `/tests`.
5. **Submit a Merge Request (MR)** to the `main` branch.
6. **Ensure All Tests Pass** before the merge.

## Sequence Diagram Example
Refer to the sequence diagram example from `docs/workflows/edgecloud/get_av_zones.md` for guidance on workflow structure: