Mode

.github/PULL_REQUEST_TEMPLATE.md

@@ -12,9 +12,9 @@ about: A template PR for code review with a checklist
 
 <!-- describe the challenge you will solve -->
 
-## Behavior
+# Behavior
 
-### Files
+## Files
 
 - [ ] The file name describes the function's behavior
 - [ ] There is a module docstring in the function file

.github/workflows/ci-checks.yml

@@ -4,19 +4,19 @@ on: [push, pull_request, workflow_dispatch]
 
 jobs:
   ls_linting:
-      runs-on: ubuntu-latest
-      steps:  
-        - uses: actions/checkout@v4
-        - uses: ls-lint/action@v2.2.3
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ls-lint/action@v2.2.3
 
   md_formatting:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: nosborn/github-action-markdown-cli@v3.3.0
-      with:
-        files: .
-        config_file: .markdownlint.yml
+      - uses: actions/checkout@v4
+      - uses: nosborn/github-action-markdown-cli@v3.3.0
+        with:
+          files: .
+          config_file: .markdownlint.yml
 
   py_formatting:
     runs-on: ubuntu-latest
@@ -55,11 +55,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: python version
         run: python --version
         shell: bash
-      
+
       - name: Check for test files
         id: check_tests
         run: |
@@ -73,7 +73,7 @@ jobs:
             echo "has_tests=false" >> $GITHUB_OUTPUT
           fi
         shell: bash
-      
+
       - name: Python - Run Tests
         if: steps.check_tests.outputs.has_tests == 'true'
         run: python -m unittest

.ls-lint.yml

@@ -15,3 +15,4 @@ ignore:
   - __pycache__
   - .ls-lint.yml
   - .markdownlint.yml
+  - .assets

.vscode/settings.json

@@ -122,5 +122,5 @@
       "source.fixAll.ruff": "explicit",
       "source.organizeImports.ruff": "explicit"
     }
-  }
+  },
 }

README.md

@@ -0,0 +1,69 @@
+# MIT Emergent Talent Foundation Track Assignment - Group 12
+
+![logo](.assets/logo.png)
+
+Welcome to the repository for **Group 12**'s assignment as part of the MIT Emerging
+Talent Foundation
+Track. This repository represents our collaborative effort to explore, learn, and
+apply essential skills in software development through the implementation of a
+**calculator project**. Each member of the team is contributing unique functionalities
+to the calculator, reviewing each other’s code, and refining the project as a group.
+
+## Project Overview
+
+This repository serves as the final deliverable for the Foundation Track, showcasing
+our teamwork and dedication to mastering foundational concepts in software development.
+Our primary objective is to collaboratively design and develop a calculator, with
+every team member contributing to its various functionalities.
+
+As a team of **10 emerging talents**, we are working together to:
+
+- Implement different features of the **calculator project**, including basic arithmetic,
+advanced functions, and more.
+- Collaborate on code reviews to ensure high quality and maintainability.
+- Utilize **Git** for version control and collaboration.
+- Navigate and manage projects effectively on **GitHub** using issues, pull requests,
+and project boards.
+- Adhere to **test-driven development (TDD)** cycles to ensure robust and reliable
+code.
+
+## Tools and Technologies
+
+- **Programming Language**: Python
+- **Version Control**: Git, integrated with GitHub
+- **Editor**: Visual Studio Code (VS Code) with extensions to enhance productivity
+- **Collaboration**: GitHub issues, pull requests, and project boards
+
+## About Group 12
+
+We are a motivated and enthusiastic group of learners, collaborating as contributors
+to this shared repository. This assignment is more than an assessment requirement
+for us—it is an opportunity to build skills, share knowledge, and grow together as
+a team. Through the development of this calculator project, we aim to foster a culture
+of learning and innovation, focusing on:
+
+- **Teamwork**: Working together to design, implement, and refine the calculator’s
+features.
+- **Communication**: Ensuring clear and constructive collaboration during reviews
+and discussions.
+- **Continuous Learning**: Building technical and soft skills through hands-on experience
+and feedback.
+
+## Project Structure
+
+The calculator project is structured to ensure modularity and ease of collaboration.
+Key elements include:
+
+- **Feature Modules**: Each team member is responsible for implementing specific
+features, such as addition, subtraction, or other advanced scientific functions.
+- **Testing**: A dedicated test suite ensures all functionalities work as intended,
+following TDD principles.
+- **Documentation**: Comprehensive documentation accompanies the code to ensure
+clarity and usability.
+
+---
+
+We invite you to explore this repository and witness our journey of growth, teamwork,
+and learning through the development of this calculator project.
+
+Thank you for visiting our repository!

collaboration/README.md

@@ -2,4 +2,63 @@
 
 <!-- group norms summary -->
 
+## Group Norms Summary  
+
+The group values open communication, mutual respect, and collaboration through
+clear updates, constructive feedback, and trust. Meetings are punctual, inclusive,
+and focused on progress, while conflicts are resolved respectfully. Flexibility
+and support ensure individual growth and team success.
+
+---
+
 <!-- group norms list -->
+
+## Group Norms  
+
+1. **Open Communication**
+   - Share ideas freely, listen actively, and use platforms like Slack and GitHub
+   for updates and collaboration.
+   - Channels: Use Slack for updates and general communication, and GitHub for technical
+  discussions. Zoom or other tools may be used for synchronous discussions.
+   - Response Time: Respond to messages within
+  one working day on weekdays to ensure timely progress.
+
+2. **Respect for Time**  
+   Adhere to meeting schedules, start and end meetings punctually, and communicate
+   any delays or absences in advance.
+
+3. **Constructive Feedback**  
+   - Give specific, respectful, and actionable feedback to help team members grow
+   and improve.
+   - Use a feedback framework like "What went well, What can improve, and How to
+  improve" for clarity and effectiveness.
+
+4. **Asynchronous Work**  
+   Update task progress regularly and respect individual schedules while ensuring
+   timely completion of tasks.
+
+5. **Team Support**  
+   Assist members facing challenges by sharing resources, guidance, and technical
+   expertise.
+
+6. **Conflict Resolution**  
+   - Address disagreements calmly, focusing on ideas rather than individuals, and
+   use votes or polls to resolve prolonged debates.
+   - Resolve disagreements by focusing on ideas rather than individuals.
+
+7. **Trust and Transparency**  
+   Build trust through consistent communication, meet deadlines, and handle damaged
+   trust openly and maturely.
+
+8. **Inclusivity and Respect**  
+   Value diverse perspectives and ensure everyone has a chance to participate without
+   fear of exclusion or disrespect.
+
+9. **Documentation and Clarity**  
+   - Maintain clear and updated documentation for tasks, code, and decisions to support
+   collaborative work.
+   - Use templates for consistent documentation across the team.
+
+10. **Focus on Growth**  
+   Share learning opportunities, celebrate wins, and embrace challenges as opportunities
+   to improve collectively.

collaboration/communication.md

@@ -13,35 +13,46 @@ ______________________________________________________________________
 
 ## Communication Schedule
 
-| Day | How | The topic of discussion | | --- | :-: | ----------------------- |
-| | | |
+| Day         | How        | The topic of discussion         |
+| ----------- | ---------  | ------------------------------ |
+| 23.12.24    | Kick-off   | Introduction and project overview |
+| 30.12.2024  | Weekly update | Progress review and task allocation |
+| 06.01.2025  | Deadline Check | Retrospective and deadline review |
 
 ## Communication Channels
 
-how often will we get in touch on each channel, and what we will discuss there:
+How often will we get in touch on each channel, and what we will discuss there:
 
-- **Issues**:
-- **Pull Requests**:
-- **Slack/Discord**:
-- **Video Calls**:
+- **Issues**: Asynchronous, to discuss and track tasks.
+- **Pull Requests**: Asynchronous, to review and merge code changes.
+- **Slack/WhatsApp**: Asynchronous, for general communication and updates.
+- **Video Calls**: Weekly on Mondays, with additional one-on-one calls as needed.
 
 ______________________________________________________________________
 
 ## Availability
 
 ### Availability for calling/messaging
 
-| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday | |
------- | :----: | :-----: | :-------: | :------: | :----: | :------: | :----: |
-| _name_ | | | | | | | |
+|Day|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday|
+|-|-|-|-|-|-|-|-|
+|Yevheniia Rudenko|14:00-20:00|14:00-20:00|14:00-20:00| 14:00-20:00|14:00-20:00|19:00-21:00|19:00-21:00|
+|Abdul Qader Dost|17:00-21:00| 17:00-21:00|17:00-21:00| 17:00-21:00 |17:00-21:00|14:00-20:00|14:00-20:00|
+|Awaab Hussein|21:00-00:00|21:00-00:00| 21:00-00:00|21:00-00:00|21:00-00:00|21:00-00:00|21:00-00:00|
+|Lukmon Alao|21:00-00:00|21:00-00:00| 21:00-00:00|21:00-00:00|21:00-00:00|21:00-00:00|21:00-00:00|
+|Ridwan Ayinde|21:00-00:00|21:00-00:00| 21:00-00:00|21:00-00:00|21:00-00:00|13:00-16:00|13:00-16:00|
+|Zephaniah Okoye|19:00-23:00|19:00-23:00|19:00-23:00|19:00-23:00|19:00-23:00|12:00-17:00|14:00-19:00|
+|Olubusayo Solola|20:00-00:00|21:00-00:00| 20:00-00:00|21:00-00:00|20:00-00:00|13:00-16:00|12:00-16:00|
 
 ### How many hours everyone has per day
 
-- name: _5h_;
-- name: _6h_;
-- name: _5h_;
-- name: _4h_;
-- name: _3h_;
+- Yevheniia Rudenko: _~5h_;
+- Abdul Qader Dost: _~4_;
+- Awaab Hussein: _~3h_;
+- Lukmon Alao: _3h_;
+- Ridwan Ayinde: _3h_;
+- Zephaniah Okoye: _~4h_;
+- Olubusayo Solola: _2h_;
 
 ## Asking for Help
 

collaboration/constraints.md

@@ -2,7 +2,9 @@
 
 # Constraints
 
-Some boundaries around our project.
+This document outlines the key boundaries and constraints for our project.
+These guidelines will help ensure alignment and smooth collaboration throughout
+the project.
 
 ## External
 
@@ -14,6 +16,22 @@ Some boundaries around our project.
   - power or connectivity
   - ...
 -->
+These constraints are beyond our team's control and have
+been imposed by external factors:
+
+- **Official Deadline:** The project must be completed by **10.01.2025**
+(extended until 12.01.2025).
+- **Number of Unit test:** We were not under any compulsion to have
+a specific number of unit tests, however we were advised to test our
+functions in different ways in order to make it robust, reliable, and
+behaves correctly under any conditions such as edge cases that ensures
+our software under unusual but valid inputs still works.
+- **Tools and Platforms:** We will use **GitHub** for version
+control and **Python** for development.
+- **Code Review Requirements:** Each pull request must be reviewed
+by at least one other team member before merging.
+- **Accessibility and Connectivity:** Team members must ensure they have reliable
+internet access to collaborate effectively.
 
 ## Internal: Involuntary
 
@@ -22,6 +40,23 @@ Some boundaries around our project.
   - each of your individual skill levels
   - amount of time available to work on the project
 -->
+These constraints come from within our team and are beyond our control:
+
+- **Time Zone Differences:** Team members are in different time zones,
+requiring asynchronous work and collaboration.
+- **Varied Availability:** Each team member has different primary
+responsibilities, which may limit available time for the project.
+- **Varying Skill Levels:** Team members have different levels of experience
+with **Python** and **GitHub**, which may affect task completion speed and code quality.
+- **Learning Curves:** As this project is part of a learning track, team members
+are still in the process of mastering some of the technologies and practices, which
+may affect productivity.
+- **Health and Well-being:** Team members' health and well-being take priority,
+   and any health-related issues may impact project timelines.
+- **Unforeseen Circumstances:** Unexpected events like personal
+   emergencies may affect team members' availability.
+- **Work-Life Balance:** Team members must balance project work
+  with other personal and professional commitments.
 
 ## Internal: Voluntary
 
@@ -32,3 +67,34 @@ Some boundaries around our project.
   - the number of hours you want to spend working
   - only using the colors black and white
 -->
+
+These constraints are decisions made by the team to help scope and guide the project:
+
+- **Submission Requirements:** All personal branches with functions must be
+added to the project by **06.01.2025** (internal deadline),
+with corresponding pull requests for each team member.
+- **Task Division:** Team members will work on separate branches to minimize
+merge conflicts and maintain clear ownership of tasks.
+- **Review Process:** Each pull request must be thoroughly reviewed by at
+least one other team member to ensure code quality and prevent errors.
+- **Communication Channels:** We will use **Slack/WhatsApp** for general communication
+and **GitHub** for technical discussions. **Zoom** may be used for synchronous
+meetings if necessary.
+- **Learning Goals:** Each team member will contribute tasks that align with
+their personal learning objectives for the project.
+- **Coding Standards:** We will follow a common coding style guide to ensure consistency
+throughout the project. All code must adhere to **PEP8** standards and be well-documented.
+- **Meeting Cadence:** Regular team meetings will be held once
+   a week to ensure alignment and progress tracking.
+- **Documentation Standards:** All code and project documentation must be
+   maintained in a consistent and organized manner.
+- **Code Quality Metrics:** The team will adhere to code quality metrics such as
+   maintaining a certain percentage of test coverage and ensuring minimal code duplication.
+- **Knowledge Sharing:** Team members will share their learnings
+   and insights through regular knowledge-sharing sessions.
+
+---
+
+This document serves as a framework to ensure all team members understand
+the constraints and expectations for the project. All changes and feedback will
+be reviewed before merging into the main branch.