Skip to content

Commit

Permalink
Add gitflow and branch rules
Browse files Browse the repository at this point in the history
  • Loading branch information
amarouane-ABDELHAK committed Oct 2, 2024
1 parent e4d2573 commit 5e016b2
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,23 @@ Test in dev mode
npm run dev
```

## Git Workflow

This project follows a Gitflow branching model:

- Feature/Bugfix Branches: Start development from a feature or bugfix branch. Use a meaningful branch name like feature/your-feature or bugfix/your-bugfix.

- Pull Request to Development Branch: When your work is ready, open a pull request (PR) from your feature or bugfix branch to the development branch.

- Staging Deployment: Once the PR is merged into the development branch, the changes will automatically be deployed to the staging environment for further testing.

- Production Deployment: If the changes in staging are approved, open a PR from the development branch to the main branch. Upon merging, the changes will be deployed to the production environment.

## Branch Protection Rules
- Development Branch: The development branch is protected, and direct commits are not allowed. All changes must come through pull requests.

- Main Branch: The main branch is also protected and only accepts pull requests from the development branch.

## Configuration

The ```config.json``` file is a vital metadata file that points the application to the proper video and image service endpoints. For the application to run properly, it’s important to configure the file according to the following parameters.
Expand Down

0 comments on commit 5e016b2

Please sign in to comment.