changes

.github/PULL_REQUEST_TEMPLATE.md

@@ -55,7 +55,6 @@ about: A template PR for code review with a checklist
 - [ ] The function's name describes it's behavior
 - [ ] The function's name matches the file name
 - [ ] The function has correct type annotations
-- [ ] The function is not called in the function file
 
 ## Strategy
 
@@ -83,7 +82,5 @@ about: A template PR for code review with a checklist
 - [ ] Variable names are clear and helpful
 - [ ] The code follows the strategy as simply as possible
 - [ ] The implementation is as simple as possible given the strategy
-- [ ] There are no commented lines of code
-- [ ] There are no `print` statements anywhere
 - [ ] The code includes defensive assertions
 - [ ] Defensive assertions include as little logic as possible

.vscode/settings.json

@@ -3,7 +3,7 @@
   //-------- Editor configuration --------
 
   // Controls auto save of editors that have unsaved changes.: https://code.visualstudio.com/docs/editor/codebasics#_save-auto-save
-  "files.autoSave": "onFocusChange",
+  "files.autoSave": "off",
 
   // Format a file on save. A formatter must be available.
   "editor.formatOnSave": true,
@@ -124,6 +124,15 @@
     }
   },
   "cSpell.words": [
-    "Mayar"
+    "Gibril",
+    "Nouman",
+    "Osama",
+    "Rafaa",
+    "Reem",
+    "Safia",
+    "Mayar",
+    "Tilal"
+    "Mayar",
+    "Testdraw"
   ]
 }

README.md

@@ -0,0 +1,92 @@
+# Collabor8 - MIT Emerging Talent ET6 Group 27
+
+We are **Collabor8**, a team formed as part of the
+ **MIT Emerging Talent program**. Our group consists of:
+
+- Omnia Mustafa *(Group Leader)*
+- Ahmed Goutbi *(Vice Leader)*
+- Ayham Hasan
+- Mohamad Tilal
+- Mayar Agab
+- Reem Osama
+- Safa Ishag
+- Safia Gibril Nouman
+- Saja Abu Safia
+- Rafaa Ali
+
+We are collaborating on a GitHub project to enhance our understanding and
+application of version control while improving our programming skills.
+
+## Project Overview
+
+This project focuses on solving a selected set of problems while learning how
+to effectively use GitHub for version control. The selection process for these
+problems mimicked the **Secret Santa** game:
+
+1. We discussed each member's strengths and weaknesses, level of experience, and
+knowledge.
+2. Based on this discussion, a list of problems was created, ensuring that each
+participant received two problems chosen by another member.
+
+### Learning Goals
+
+- Gain hands-on experience with GitHub workflows.
+- Collaborate effectively within a team.
+- Improve programming skills through problem-solving and peer reviews.
+- Provide constructive feedback on each other's code.
+
+More on Learning Goals in `collaberations/learning_goals.md`
+
+## Workflow
+
+Here is a step-by-step guide to our workflow:
+
+1. **Branch Creation**: Create a new branch named after your problem file.
+2. **File Addition**: Add your problem file(s) to the branch.
+3. **Issue Creation**: Create an issue for the problem and a corresponding card
+on the project board.
+4. **Pull Request**: Once the problem is solved, add the solutions with
+corresponding test file as a commit, and create a pull request (PR) to merge
+your changes into the main branch.
+5. **Card Update**: Update the card on the project board and mark it as "Ready
+for Review."
+6. **Peer Review**: Another member will review your code and provide feedback.
+7. **Merge**: After addressing any feedback, your PR can be merged into the main
+branch.
+
+## Collaboration Tools
+
+- **GitHub Project Board**: Tracks the progress of issues and pull requests.
+- **Slack**: Main Communication tool
+- **Google Meet**: Meetings three times a week, or according to requirements.
+- **Collaboration Directory**: Contains additional details about:
+  - Collaboration process.
+  - Learning objectives.
+  - Meeting notes.
+
+## Meetings and Sessions
+
+We conducted several meetings and one dedicated session on GitHub usage. During
+these, we discussed:
+
+- General GitHub commands.
+- Best practices for our workflow.
+- Troubleshooting common issues.
+
+Meetings times and agenda are discussed a few days before the date to schedule
+best time that suits the majority of the team. Voting is done through **Polly**,
+a third party service of Slack.
+
+For more information refer to `collaberations/communication.md`
+
+## Contact
+
+For any questions or further information, please refer to the files in the
+collaboration directory or contact any group member.
+
+Happy collaborating!
+
+---
+<!-- markdownlint-disable MD036 -->
+**MIT Emerging Talent ET6 Group 27 - Collabor8**
+<!-- markdownlint-enable MD036 -->

collaboration/communication.md

@@ -9,39 +9,144 @@
 
 # Communication
 
-______________________________________________________________________
+As a team we agreed that we will make a poll in Slack
+to check the validity of all the team, and will take the highest vote
+as the meeting time. And before ending the meeting will discuss
+about what do we want to do, what will be our next step
+and what is the timeline for these tasks.
+We use Google Meet as the meeting channel,
+while Slack is the channel for quick questions,
+meetings plans and friendly communication channel.
+We use GitHub as the basic channel for coding,
+raise a challenge or any professional communication.
 
-## Communication Schedule
+## Meeting Agendas
 
-| Day | How | The topic of discussion | | --- | :-: | ----------------------- |
-| | | |
+### First Meeting
 
-## Communication Channels
+#### Date: December 20, 2024
 
-how often will we get in touch on each channel, and what we will discuss there:
+##### Overview of the first meeting
 
-- **Issues**:
-- **Pull Requests**:
-- **Slack/Discord**:
-- **Video Calls**:
+We held an introductory meeting where everyone introduced themselves.
+Our main focus was on two documents:
+"Defining Group Norms" and "Tools of Collaborative Development."
 
-______________________________________________________________________
+##### Key Points of the first meeting
 
-## Availability
+- Defining Group Norms:
+Members should contribute by answering the questions
+in the brainstorm section, adding their responses as bullet points,
+and commenting with their names.
+- Tools of Collaborative Development:
+Members should pick a subject from the document,
+add three points, and write an explanation at the bottom.
+- Next Steps:
+Review and contribute to both documents.
+Vote in the next meeting poll to schedule it.
 
-### Availability for calling/messaging
+### Second Meeting
 
-| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday | |
------- | :----: | :-----: | :-------: | :------: | :----: | :------: | :----: |
-| _name_ | | | | | | | |
+#### Date: December 21, 2024
 
-### How many hours everyone has per day
+##### Overview of the second meeting
 
-- name: _5h_;
-- name: _6h_;
-- name: _5h_;
-- name: _4h_;
-- name: _3h_;
+In this meeting, we reviewed the "Defining Group Norms"
+and "Tools of Collaborative Development" documents,
+planned the repository, and discussed next steps for code review
+and the group name.
+
+##### Key Points of the second meeting
+
+- Document Updates
+ Agreed on updates to the "Defining Group Norms"
+and "Tools of Collaborative Development" documents.
+Members who haven’t continued their contributions to the
+"Tools of Collaborative Development" file should do so.
+- Repository Progress:
+ Mohamed Tilal would summarize the brainstorming ideas
+to be pushed later.
+- Group Name:
+ Members should participate in the poll for the group name
+and add suggestions if desired.
+- Next Meeting Plans:
+ The next meeting would be a walkthrough with
+Reem Osama on GitHub.
+ Problem selection for the code review will include suggestions
+from Reem’s game.
+ Members should vote in the poll to finalize the next meeting time.
+
+### Third Meeting
+
+#### Date: December 24, 2024
+
+##### Overview of the third meeting
+
+The meeting focused on a review session for GitHub
+and the key functions we’ll use for the project.
+
+###### Key Points of the third meeting
+
+- GitHub Review:
+Omnia Mustafa - Abdulgadir outlined the main
+functions in a post in Slack.
+Reem Osama provided a detailed file containing all the notes,
+which would serve as a reference moving forward.
+- Acknowledgment:
+Special thanks to Reem Osama for her incredible effort
+in the session and for preparing and sharing the notes.
+Your contribution is greatly appreciated!
+- Next Meeting:
+Next meeting would focus on choosing the problems and
+discussing our game plan moving forward.
+
+### Forth Meeting
+
+#### Date: December 25, 2024
+
+##### Overview of the forth meeting
+
+This meeting was all about understanding each other's challenges
+and identifying the person who will create a challenge for who.
+
+##### What's next
+
+- Omnia Mustafa - Abdulgadir wrote down everyone's experiences
+and perspectives on programming.
+- Reem Osama provided the link to find out
+who will create the challenge for who.
+- Once know the person, each person the team fill out
+the second form to communicate their challenges.
+
+### Fifth Meeting
+
+#### Date: December 29, 2024
+
+##### Overview of the fifth meeting
+
+The meeting focused on task assignments,
+problem workflows, and planning the next steps.
+
+##### Key Points of the fifth meeting
+
+###### Task Assignments
+
+- Safia Gibril Nouman would assign two problems
+to Reem Osama and Rafaa ALI.
+- Ahmed would work on the Learning Goals and Constraints files.
+- Omnia Mustafa - Abdulgadir would contribute to the Collaborative file.
+- Reem Osama would collaborate on the README file.
+
+###### Problem Workflow
+
+ By December 30, 2024, each member must:
+
+- Create a new Python file named after their assigned problem.
+- Create a branch, add the file to it, and push it.
+- Create an issue for the problem with the same name and add it to the project board.
+After completing these steps, members have until January 2, 2025,
+to solve their assigned problems, allowing the team to
+start reviewing them afterward.
 
 ## Asking for Help
 
@@ -50,5 +155,5 @@ stubbornly getting no where. Here is a general guide for when to ask for help
 based on how long you've been stuck on the same problem:
 
 1. _0 -> 30 min_: Try on your own
-1. _30 -> 60 min_: Ask your group for help
-1. _60+ min_: Tag your coaches in Slack or GitHub
+2. _30 -> 60 min_: Ask your group for help
+3. _60+ min_: Tag your coaches in Slack or GitHub