forked from MIT-Emerging-Talent/ET6-practice-code-review
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
415 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| ignore: | ||
| - venv | ||
| - .github | ||
|
|
||
| MD033: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | <[email protected]> | | ||
| | Alemayehu Kiros | Developer, Reviewer | <[email protected]> | | ||
| | Khadija al Ramlawi | Developer, Reviewer | <[email protected]> | | ||
| | Henry Ogoe | Developer, Reviewer | <[email protected]> | | ||
| | Suhrob Muborakshoev | Developer, Reviewer | <[email protected]> | | ||
| | Mithchell Cenatus | Developer, Reviewer | <[email protected]> | | ||
| | Olumide Kolawole | Developer, Reviewer | <[email protected]>| | ||
| | Mykyta Kondratiev | Developer, Reviewer | <[email protected]>| | ||
| | Dmytro Klymenko | Developer, Reviewer | <[email protected]> | | ||
| | Manezhah Mohmand | Developer, Reviewer | <[email protected]> | | ||
|
|
||
| --- | ||
|
|
||
| ## Repository Structure | ||
|
|
||
| <details> | ||
| <summary>Click to expand/collapse the repository structure</summary> | ||
|
|
||
| ```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 | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| --- | ||
|
|
||
| ## 🛠 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). |
Oops, something went wrong.