From 58f647918d8901f160a57d2cc6eb0becf969d122 Mon Sep 17 00:00:00 2001 From: olumide-AI Date: Wed, 25 Dec 2024 08:12:19 -0800 Subject: [PATCH 1/4] i added my initial changes for the group communication.md --- collaboration/communication.md | 66 +++++++++++++++++++++++++--------- 1 file changed, 50 insertions(+), 16 deletions(-) diff --git a/collaboration/communication.md b/collaboration/communication.md index 4ed6b7f2d..37f91ffab 100644 --- a/collaboration/communication.md +++ b/collaboration/communication.md @@ -7,41 +7,68 @@ you can share the rest in confidence with you group by another channel --> -# Communication +# Communication for Group Pacific ______________________________________________________________________ ## Communication Schedule -| Day | How | The topic of discussion | | --- | :-: | ----------------------- | -| | | | +| Day | How | The Topic of Discussion | +|-------------|-----------------|----------------------------| +| Monday | Slack | Weekend progress updates | +| Tuesday | Slack | Prep for video call | +| Wednesday | Video call | Mid week check-in | +| Thursday | Slack | Progress updates | +| Friday | Slack | Prep for video call | +| Saturday | Video Call | Code review, code help | +| Sunday | Nothing | Rest Day | ## Communication Channels -how often will we get in touch on each channel, and what we will discuss there: +Our group will get in touch **twice a week** until the +deadline of the project which is (**Jan 10th**) -- **Issues**: -- **Pull Requests**: -- **Slack/Discord**: -- **Video Calls**: +### Below are the primary communication channels and their purposes: + +- **Issues**: For bugs, task tracking and more [Evan link on issues](https://mitemergingtalent.slack.com/files/U03PC2VR746/F0862S5644E/creating-issues-from-repository.mp4) +- **Pull Requests**: Code review and discussion +[git and github for poets is a great video to learn PR](https://www.youtube.com/playlist?list=PLRqwX-V7Uu6ZF9C0YMKuns9sLDzK6zoiV) +- **Slack**: Daily communication, quick updates, screen shots, e.tc. +- **Video Calls**: Yuri will set this up bi-Weekly check-ins, in-depth discussion +and more +- **Project Boards**: Visual tracking of task and TO-DO list ______________________________________________________________________ ## Availability -### Availability for calling/messaging +### Weekly Availability for Calling/Messaging -| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday | | ------- | :----: | :-----: | :-------: | :------: | :----: | :------: | :----: | -| _name_ | | | | | | | | +| Team Member | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday| +|-------------|--------|---------|-----------|----------|--------|----------|--------| +| Olumide | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 8AM-8PM | 8AM-8PM| +| Sukhrob | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 8AM-8PM | 8AM-8PM| +| Yuri | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 8AM-8PM | 8AM-8PM| +| Alemayehu | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 8AM-8PM | 8AM-8PM| +| Dmytro | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 8AM-8PM | 8AM-8PM| +| Henry | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 8AM-8PM | 8AM-8PM| +| Khadija | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 8AM-8PM | 8AM-8PM| +| Manezhah | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 8AM-8PM | 8AM-8PM| +| Mithchell | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 8AM-8PM | 8AM-8PM| +| Mykyta | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 4-8PM | 8AM-8PM | 8AM-8PM| -### How many hours everyone has per day +### Daily availability in hours - Sukhrob: _5h_; - Yuri: _6h_; -- name: _5h_; -- name: _4h_; -- name: _3h_; +- Olumide: _4h_; +- Alemayehu: _4h_; +- Dmytro: _3h_; +- Henry: _3h_; +- Khadija: _3h_; +- Manezhah: _3h_; +- Mithchell: _3h_; +- Mykyta: _3h_; ## Asking for Help @@ -52,3 +79,10 @@ 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 + +## Additional notes + +- All team abide by the **group norms** at all times +- Please document everything so everyone can understand +- Communicate at all times +- Always ask **why** don't just do From 4faadbc5838dd26a6eb1ca00fd46b67e0e514a9f Mon Sep 17 00:00:00 2001 From: Yuri Spizhovyi Date: Thu, 26 Dec 2024 04:20:20 -0800 Subject: [PATCH 2/4] docs: update README.md with project overview, contribution guide, and corrected TOC links --- .markdownlint.yml | 2 + README.md | 320 ++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 310 insertions(+), 12 deletions(-) diff --git a/.markdownlint.yml b/.markdownlint.yml index ee6205f5c..b2d26ed41 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -1,3 +1,5 @@ ignore: - venv - .github + +MD033: false diff --git a/README.md b/README.md index 9f81c2164..530eacd1e 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,320 @@ -# Draft README +# The Pacific 🌊: Group Code Review Exercise -# Group 1 - The Pacific 🌊 +Welcome to **The Pacific** - a collaborative coding initiative by **Group 1** of +the MIT Emerging Talent Program. Together, we aim to code, learn, and grow as +developers while fostering a supportive and inspiring team environment. -Welcome to **The Pacific** - a collaborative coding initiative by **Group 1** of the MIT Emerging Talent Program. Together, we aim to code, learn, and grow as developers while fostering a supportive and inspiring team environment. +--- + +## Table of Contents + +1. [Project Overview](#project-overview) +2. [How to Contribute](#how-to-contribute) +3. [Project Goals](#project-goals) +4. [Team Composition](#team-composition) +5. [Repository Structure](#repository-structure) +6. [Setup and Usage](#setup-and-usage) +7. [Roles and Responsibilities](#roles-and-responsibilities) +8. [Task Breakdown](#task-breakdown) +9. [Definition of Done](#definition-of-done) +10. [Tools and Technologies](#tools-and-technologies) +11. [Milestones](#milestones) + +--- + +## Project Overview + +Welcome to **The Pacific** - a collaborative coding initiative by **Group 1** of +the MIT Emerging Talent Program. Together, we aim to code, learn, and grow as +developers while fostering a supportive and inspiring team environment. + +This repository serves as the hub for our group collaboration, where we: + +1. **Collaborate on coding projects**: Work together on group projects to hone our + technical skills. +2. **Learn from each other**: Share knowledge, resources, and tips to help everyone + grow. +3. **Code reviews**: Provide constructive feedback to improve the quality of our + code and learn best practices. +4. **Build community**: Strengthen our team spirit as we progress through the + MIT Emerging Talent Program. + +--- + +## How to Contribute + +We encourage all team members to actively participate. Here's how you can +contribute: + +1. Check the **Tasks** section for assigned roles and deadlines. +2. Follow the **Setup and Usage** guide to get started with the repository. +3. Submit pull requests for code contributions, ensuring your work meets the + **Definition of Done.** +4. Participate in code reviews by providing constructive feedback on your peers' + submissions. --- -## πŸš€ Project Overview +## Project Goals -This repository serves as the hub for our group collaboration, where we: +1. Strengthen Python programming and unit testing skills. +2. Practice professional GitHub workflows, including pull requests and code reviews. +3. Develop teamwork and collaboration skills. +4. Prepare for group-oriented Data Science projects. -1. **Collaborate on coding projects**: Work together on group projects to hone our technical skills. -2. **Learn from each other**: Share knowledge, resources, and tips to help everyone grow. -3. **Code reviews**: Provide constructive feedback to improve the quality of our code and learn best practices. -4. **Build community**: Strengthen our team spirit as we progress through the MIT Emerging Talent Program. +--- + +## Team Composition + +| **Name** | **Role** | **Email** | +|-------------------------|------------------------|-----------------------------| +| Yuriy Spizhovy | Developer, Reviewer | | +| Alemayehu Kiros | Developer, Reviewer | | +| Khadija al Ramlawi | Developer, Reviewer | | +| Henry Ogoe | Developer, Reviewer | | +| Suhrob Muborakshoev | Developer, Reviewer | | +| Mithchell Cenatus | Developer, Reviewer | | +| Olumide Kolawole | Developer, Reviewer | | +| Mykyta Kondratiev | Developer, Reviewer | | +| Dmytro Klymenko | Developer, Reviewer | | +| Manezhah Mohmand | Developer, Reviewer | | + +--- + +## Repository Structure + +
+Click to expand/collapse the repository structure + +```plaintext +. +β”‚ .gitignore +β”‚ .ls-lint.yml +β”‚ .markdownlint.yml +β”‚ CONTRIBUTING.md +β”‚ LICENSE +β”‚ README.md +β”‚ +β”œβ”€β”€β”€.github +β”‚ β”‚ PULL_REQUEST_TEMPLATE.md +β”‚ β”‚ +β”‚ β”œβ”€β”€β”€ISSUE_TEMPLATE +β”‚ β”‚ help_wanted.md +β”‚ β”‚ meeting_agenda.md +β”‚ β”‚ new_challenge.md +β”‚ β”‚ question.md +β”‚ β”‚ +β”‚ └───workflows +β”‚ ci-checks.yml +β”‚ +β”œβ”€β”€β”€.vscode +β”‚ extensions.json +β”‚ launch.json +β”‚ settings.json +β”‚ +β”œβ”€β”€β”€collaboration +β”‚ β”‚ communication.md +β”‚ β”‚ constraints.md +β”‚ β”‚ learning_goals.md +β”‚ β”‚ README.md +β”‚ β”‚ retrospective.md +β”‚ β”‚ +β”‚ └───guide +β”‚ β”‚ 0_repository_setup.md +β”‚ β”‚ 1_group_norms.md +β”‚ β”‚ 2_learning_goals.md +β”‚ β”‚ 3_constraints.md +β”‚ β”‚ 4_communication.md +β”‚ β”‚ 5_project_board.md +β”‚ β”‚ 6_development.md +β”‚ β”‚ 7_retrospective.md +β”‚ β”‚ README.md +β”‚ β”‚ +β”‚ └───assets +β”‚ branching_strategy.svg +β”‚ claim_branch_review_merge.svg +β”‚ +β”œβ”€β”€β”€notes +β”‚ β”‚ README.md +β”‚ β”‚ +β”‚ └───meeting_minutes +β”‚ 12_24_2024_meeting_minute.md +β”‚ +└───solutions + β”‚ README.md + β”‚ + β”œβ”€β”€β”€yuriy_spizhovy + β”‚ solution_1.py + β”‚ solution_2.py + β”œβ”€β”€β”€alemayehu_kiros + β”‚ solution_1.py + β”‚ solution_2.py + β”œβ”€β”€β”€khadija_al_ramlawi + β”‚ solution_1.py + β”‚ solution_2.py + β”œβ”€β”€β”€henry_ogoe + β”‚ solution_1.py + β”‚ solution_2.py + β”œβ”€β”€β”€suhrob_muborakshoev + β”‚ solution_1.py + β”‚ solution_2.py + β”œβ”€β”€β”€mithchell_cenatus + β”‚ solution_1.py + β”‚ solution_2.py + β”œβ”€β”€β”€olumide_kolawole + β”‚ solution_1.py + β”‚ solution_2.py + β”œβ”€β”€β”€mykyta_kondratiev + β”‚ solution_1.py + β”‚ solution_2.py + β”œβ”€β”€β”€dmytro_klymenko + β”‚ solution_1.py + β”‚ solution_2.py + β”œβ”€β”€β”€manezhah_mohmand + β”‚ solution_1.py + β”‚ solution_2.py + └───tests + β”œβ”€β”€β”€yuriy_spizhovy + β”‚ test_solution_1.py + β”‚ test_solution_2.py + β”œβ”€β”€β”€alemayehu_kiros + β”‚ test_solution_1.py + β”‚ test_solution_2.py + β”œβ”€β”€β”€khadija_al_ramlawi + β”‚ test_solution_1.py + β”‚ test_solution_2.py + β”œβ”€β”€β”€henry_ogoe + β”‚ test_solution_1.py + β”‚ test_solution_2.py + β”œβ”€β”€β”€suhrob_muborakshoev + β”‚ test_solution_1.py + β”‚ test_solution_2.py + β”œβ”€β”€β”€mithchell_cenatus + β”‚ test_solution_1.py + β”‚ test_solution_2.py + β”œβ”€β”€β”€olumide_kolawole + β”‚ test_solution_1.py + β”‚ test_solution_2.py + β”œβ”€β”€β”€mykyta_kondratiev + β”‚ test_solution_1.py + β”‚ test_solution_2.py + β”œβ”€β”€β”€mykyta_kondratiev + β”‚ test_solution_1.py + β”‚ test_solution_2.py + └───manezhah_mohmand + test_solution_1.py + test_solution_2.py +``` + +
--- -## πŸ›  How to Contribute +## Setup and Usage + +### Prerequisites + +- Python 3.8+ +- Git +- Text Editor (e.g., VSCode, PyCharm) + +### Clone Repository + +```bash +git clone https://github.com/MIT-Emerging-Talent/ET6-foundations-group-01.git +cd Group-Code-Review +``` + +### Install Dependencies -We encourage all team members to actively participate. Here's how you can contribute: +```bash +pip install -r requirements.txt +``` + +### Run Tests + +```bash +unittest /tests +``` + +--- + +## Roles and Responsibilities + +- **Developer and Reviewer:** Yuriy Spizhovy + - Develop and review code submissions. + - Ensure adherence to project guidelines. +- **Developer and Reviewer:** Suhrob Muborakshoev, Mithchell Cenatus + - Develop and review code submissions. + - Assist with CI/CD tasks as needed. +- **Developer and Reviewer:** Alemayehu Kiros, Khadija al Ramlawi + - Develop and review code submissions. + - Assist with documentation tasks as needed. +- **Developer and Reviewer:** Henry Ogoe, Olumide Kolawole + - Develop and review code submissions. + - Ensure adherence to coding standards. +- **Developers:** All team members + - Submit solutions and unit tests. + +--- + +## Task Breakdown + +- **Individual Tasks:** + Each team member submits: + + | **Team Member** | **Task** | **Deadline** | + |-----------------------|-------------------------------|--------------------| + | Yuriy Spizhovy | solution_1.py, solution_2.py | January 5, 2025 | + | Alemayehu Kiros | solution_1.py, solution_2.py | January 5, 2025 | + | Khadija al Ramlawi | solution_1.py, solution_2.py | January 5, 2025 | + | Henry Ogoe | solution_1.py, solution_2.py | January 5, 2025 | + | Suhrob Muborakshoev | solution_1.py, solution_2.py | January 5, 2025 | + | Mithchell Cenatus | solution_1.py, solution_2.py | January 5, 2025 | + | Olumide Kolawole | solution_1.py, solution_2.py | January 5, 2025 | + | Mykyta Kondratiev | solution_1.py, solution_2.py | January 5, 2025 | + | Dmytro Klymenko | solution_1.py, solution_2.py | January 5, 2025 | + +- **Shared Tasks:** + +| Task | Assigned Members | Deadline | +|--------------------|---------------------------------|------------------| +| communication.md | Yuriy Spizhovy, Henry Ogoe | January 10, 2025 | +| constraints.md | Alemayehu Kiros, Khadija al Ramlawi | January 10, 2025 | +| learning_goals.md | Mithchell Cenatus, Suhrob Muborakshoev | January 10, 2025| +| README.md | Olumide Kolawole, Mykyta Kondratiev | January 10, 2025 | +| retrospective.md | Dmytro Klymenko, Henry Ogoe | January 10, 2025 | + +--- + +## Definition of Done + +A task is complete when: + +1. Solutions pass all unit tests and code reviews. +2. Collaboration documents are reviewed and approved. +3. CI/CD pipelines run successfully. + +--- + +## Tools and Technologies + +- **Version Control:** Git +- **Documentation:** Markdown +- **Testing:** pytest +- **CI/CD:** GitHub Actions + +--- + +## Milestones + +| **Milestone** | **Deadline** | +|-------------------------------|--------------------| +| Repository Setup | December 20, 2024 | +| Individual Solutions | January 5, 2025 | +| Collaboration Documents | January 7, 2025 | +| Code Reviews and Finalization | January 9, 2025 | + +--- -Yuri's first commit to github +For further details, visit the project [repository](https://github.com/MIT-Emerging-Talent/ET6-foundations-group-01). From e92481f456e347108d46b6a7b5129198ac6201f6 Mon Sep 17 00:00:00 2001 From: Papsik09 Date: Thu, 26 Dec 2024 11:14:07 -0800 Subject: [PATCH 3/4] Constrains update --- collaboration/constraints.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/collaboration/constraints.md b/collaboration/constraints.md index 24079505c..6fdc6a25b 100644 --- a/collaboration/constraints.md +++ b/collaboration/constraints.md @@ -6,6 +6,13 @@ Some boundaries around our project. ## External +* **Family** - Group participants have families, where they +responsible for their routine. + +* **Work** - Time spent for the job can make overexausted, +leaving person with no energy nor motivation. + +* **Connectivity** - Group people might have issues with connection. +--> \ No newline at end of file From 8b2813664572226d59b8357735a4b177ea363d7c Mon Sep 17 00:00:00 2001 From: Sukhrob Muborakshoev Date: Thu, 26 Dec 2024 13:08:55 -0800 Subject: [PATCH 4/4] Edited section for Sukhrob Muborakshoev --- collaboration/learning_goals.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/collaboration/learning_goals.md b/collaboration/learning_goals.md index 7ea2814a7..5e081a5b0 100644 --- a/collaboration/learning_goals.md +++ b/collaboration/learning_goals.md @@ -35,11 +35,13 @@ collective and individual learning goals for this project: - Practice code reviews and incorporating feedback effectively. - Explore advanced programming techniques. -### Suhrob Muborakshoev () +### Sukhrob Muborakshoev (, ) -- Focus on creating efficient and optimized solutions. +- Learn to docstring a python file. +- Learn how to properly unittest python file. - Enhance debugging skills. -- Strengthen collaboration and teamwork. +- Learn the proper workflow on Git. +- Strengthen collaboration and teamwork in both Git and Slack. ### Manezhah Mohmand ()