feat: add guidelines and templates

2025-11-14 20:32:53 +03:30
parent a9e59ebcc2
commit 14d202eff5
2 changed files with 95 additions and 17 deletions
@@ -1,21 +1,93 @@
-## 💾 General Workflow
- Pull before editing
- Push after committing
- One person = one personal notes file (e.g., `04-Notes-JohnDoe.md`)
- Shared files like `Overview.md` → edit only if you’ve pulled recently and no one else is working on it
- Do NOT change the folder structure without notice
+# 🛠️ TA Contribution Guidelines

-## 🧠 Ownership
-| File Type            | Who Can Edit                               |
-| -------------------- | ------------------------------------------ |
-| 04-Notes-YourName.md | The owner only                             |
-| Overview.md          | Agreed upon                                |
-| Other Files          | Anyone (coordinate via Telegram or Issues) |
+All TAs are expected to follow these procedures when contributing course materials. This ensures consistency, traceability, and collaboration across all topics.

+---

-## 🛠 Tools
- Use Obsidian Git plugin or GitHub Desktop
- Keep commit messages clear: "Add summary for CNNs", not "Update"
+## 🔹 Pull Request (PR) Workflow
+
+1. **Create a branch** for the topic you are working on.  
+    Use a descriptive name:
+    ```
+    topic-name-assignment
+    topic-name-workshop
+    ```
+    
+2. **Work in pairs** whenever possible. Collaborate on the content before creating a PR.
+3. **Do not merge your own PRs.** Always request a review from at least one other TA.
+4. **Specify clearly in your PR title** whether your work is for:
+    - **Workshop**
+    - **Assignment**
+
+---
+
+## 🔹 Lectures / Workshop Content
+
+### 1. Upload lectures to **Google Drive**
+
+- All slides and resources must be uploaded to the designated Google Drive folder for each topic.
+
+### 2. Create Files in the Repo
+
+For each topic, create the following files **from templates**:
+1. **`5-TASlides.md`**
+    - Use the TA Slides template
+    - Include links to all relevant slides
+2. **`1-Workshop.md`**
+    - Use the Workshop template
+    - Update links to questions and slides
+3. **`0-Overview.md`**
+    - Use the Overview template
+    - Update:
+        - Overview section
+        - Covered in this topic section
+        - Links to Slides & Materials page you created
+        - Additional resources
+
+---
+
+## 🔹 Assignments
+
+TAs responsible for assignments should:
+
+1. Upload all assignment questions and answers to the google drive
+2. Create **`2-Assignment.md`** for the topic using the assignment template.
+3. Update links in `2-Assignment.md` to point to the uploaded materials.
+
+---
+
+## 🔹 Recommended Folder Structure
+
+```
+BasicProgrammingCourse404Assets/
+└── Topic/
+    ├── AssignmentQuestionsAndAnswer/
+    │   ├── Questions/
+    │   ├── Answers/
+    │   ├── Questions.zip
+    │   └── Answers.zip
+    ├── ProfessorSlides/
+    ├── TASlides/
+    └── WorkshopQuestionsAndAnswer/
+        ├── Questions/
+        ├── Answers/
+        ├── Questions.zip
+        └── Answers.zip
+```
+
+- Keep **Questions** and **Answers** separate for clarity.
+- Zip files are optional but recommended for easier download.
+- Always maintain this structure for every topic to keep the repo consistent.
+
+---
+
+> [!tip] Tip  
+> Before submitting your PR, double-check:
+> 
+> - File naming conventions match the templates
+>     
+> - Links work correctly
+>     
+> - All required materials are uploaded to Google Drive
+>     

-## 💥 Conflicts
- If conflict occurs, ping someone experienced or back up your changes
@@ -0,0 +1,6 @@
+## 🔗 Download
+- [Download PDF](https://drive.usercontent.google.com/u/0/uc?id=1_e2c5by8f2r-sWSpjnioXWm16mUZFTtp&export=download)
+## View PDF Online
+<iframe src="https://docs.google.com/gview?embedded=true&url=https://drive.usercontent.google.com/u/0/uc?id=1_e2c5by8f2r-sWSpjnioXWm16mUZFTtp&export=download" width="100%" height="700px" frameborder="0"> </iframe>
+
+