Workflow suggestion

README.md

@@ -15,7 +15,79 @@ competition one of the tasks is autonomy
 - OpenCV
 - Open3d
 
-# Main engineers 
+# Workflow
+
+## Branches
+
+- **main**
+  - main branch, should be always stable - every pull request to this branch should be reviewed by at least 2-3
+    persons. 
+  - merge to this branch can be done only by the project manager. 
+  - merge to this branch can be done from **dev** branch.
+  - every merge means new version of the project.
+
+- **dev** 
+  - development branch
+  - merge to this branch can be done only if all feature tests are passed.
+  - merge to this branch can be only done by feature reviewer 
+  - acceptance criteria for merge to this branch:
+    - have all functionality tests passed.
+  - merge to this branch means end of milestone.
+
+- **feature**
+  - branches for specific features
+  - use to develop new features
+
+- **bug**
+  - branches for specific bugs
+  - use to fix bugs from feature branch
+
+- **test**
+  - branches for specific features
+  - use only to test specific feature - do not add new features to this branch
+
+```markdown
+├── **main** 
+│     └── **dev**
+│           ├── **feature** 
+│           │      ├── **bug**
+│           │      └── **test**          
+│           │
+│           ├── **feature** 
+│           │      ├── **bug**
+│           │      └── **test**
+│           │
+```
+
+## Create Branches
+
+- Create a new branch for each feature or bug fix.
+- Branch names should be descriptive:
+    ```markdown
+        [feature/bug/test]/[milestone]/[short-description]
+    ```
+  Example:
+    ```markdown
+        feature/ros_introduction/start_with_ros
+    ```
+
+## Commit Messages
+
+- Commit messages should be descriptive - **obligatory use
+  of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)**
+
+## Issues
+
+- Issues have to be created with templates provided in the repository
+    - Issue template - create issue ticket
+    - Bug report - report a bug for specific issue
+- **Every issue have to have assignees and reviewer**
+
+## Pull Requests
+
+- Pull requests should be descriptive and have annotation to issue
+
+# Main engineers
 
 - [Daniel Kleczyński](https://github.com/Kleczyk)
 - [Filip Walkowicz](https://github.com/FWalkowicz)