Reem commited on
Commit
9352277
·
2 Parent(s): 8c1034b 9f32fd8

Merge branch 'main' of https://github.com/othmanreem/Data-intensive-systems

Browse files
Files changed (1) hide show
  1. README.md +32 -1
README.md CHANGED
@@ -17,7 +17,6 @@ Group project to develop in a machine learning setting. The developed [gradio](h
17
  3. Amol
18
  4. Kalle
19
 
20
- ~~5. Abdulla~~
21
 
22
  ## Usage
23
 
@@ -45,3 +44,35 @@ Run the app with ```python3 app.py```
45
 
46
  ### Outlook
47
  Input the raw video into a [reasoning vision model](https://huggingface.co/blog/nvidia/nvidia-cosmos-reason-2-brings-advanced-reasoning) and develop the workflow with [daggr](https://huggingface.co/blog/daggr) for gradio.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
  3. Amol
18
  4. Kalle
19
 
 
20
 
21
  ## Usage
22
 
 
44
 
45
  ### Outlook
46
  Input the raw video into a [reasoning vision model](https://huggingface.co/blog/nvidia/nvidia-cosmos-reason-2-brings-advanced-reasoning) and develop the workflow with [daggr](https://huggingface.co/blog/daggr) for gradio.
47
+
48
+
49
+ ### PR Review Guidelines
50
+
51
+ To ensure code quality, stability of the HuggingFace deployment, and consistent development practices, all pull requests must follow these guidelines:
52
+
53
+ #### Before creating a PR
54
+ - Code must follow project structure and naming conventions
55
+ - No `.pdf` or `.xlsx` files should be committed (these break HuggingFace sync)
56
+ - Code should pass local linting checks
57
+ - Changes should be tested locally when possible
58
+
59
+ #### CI/CD requirements
60
+ - Linting must pass before merge
61
+ - CI pipeline must complete successfully
62
+
63
+ #### PR description must include
64
+ - Clear explanation of what was implemented or changed
65
+ - Reason for the change
66
+ - Screenshots or demo output (if UI/model related)
67
+
68
+ #### Reviewer checklist
69
+ - Code readability and structure
70
+ - Consistency with project design
71
+ - No restricted file uploads (.pdf/.xlsx)
72
+ - CI pipeline passes
73
+ - No breaking changes to deployment
74
+
75
+ #### Merge rules
76
+ - PR cannot be merged if CI fails
77
+ - PR must be up-to-date with `main` branch before merging
78
+