Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed constraints #27

Closed
wants to merge 69 commits into from
Closed
Show file tree
Hide file tree
Changes from 60 commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
001fd56
Update learning_goals.md
mojtabafayyaz Dec 25, 2024
34b062a
Update learning_goals.md
mojtabafayyaz Dec 25, 2024
0d4ce0b
Update learning_goals.md
mojtabafayyaz Dec 25, 2024
a53d06a
Update learning_goals.md
mojtabafayyaz Dec 25, 2024
aa0cebf
Update learning_goals.md
mojtabafayyaz Dec 25, 2024
3f0990a
Update ci-checks.yml
mojtabafayyaz Dec 27, 2024
32f1544
Update ci-checks.yml
mojtabafayyaz Dec 27, 2024
f158317
Update ci-checks.yml
mojtabafayyaz Dec 27, 2024
feb7e3f
Update 0_repository_setup.md
mojtabafayyaz Dec 27, 2024
fb165b5
Update 0_repository_setup.md
mojtabafayyaz Dec 27, 2024
6b09049
Update 0_repository_setup.md
mojtabafayyaz Dec 27, 2024
a8e610b
Update 0_repository_setup.md
mojtabafayyaz Dec 27, 2024
64edd74
Update constraints.md
mojtabafayyaz Dec 27, 2024
8d667eb
Update communication.md
mojtabafayyaz Dec 27, 2024
9a2f599
Update learning_goals.md
mojtabafayyaz Dec 27, 2024
84bdcc7
Update README.md
mojtabafayyaz Dec 27, 2024
7f55046
Update 0_repository_setup.md
mojtabafayyaz Dec 27, 2024
c6221e1
Update README.md
mojtabafayyaz Dec 27, 2024
b0172c1
Update communication.md
mojtabafayyaz Dec 27, 2024
3c1075c
Update constraints.md
mojtabafayyaz Dec 27, 2024
108d596
Update learning_goals.md
mojtabafayyaz Dec 27, 2024
d057d14
Update README.md
mojtabafayyaz Dec 27, 2024
62de07e
Update 0_repository_setup.md
mojtabafayyaz Dec 27, 2024
2e08e80
Update README.md
mojtabafayyaz Dec 27, 2024
b98b054
Update communication.md
mojtabafayyaz Dec 27, 2024
1efbcca
Update constraints.md
mojtabafayyaz Dec 27, 2024
a616be5
Update learning_goals.md
mojtabafayyaz Dec 27, 2024
bfda115
Update README.md
mojtabafayyaz Dec 27, 2024
b078afe
Update README.md
mojtabafayyaz Dec 27, 2024
6d11c82
Update README.md
mojtabafayyaz Dec 27, 2024
f8eb4d0
Update communication.md
mojtabafayyaz Dec 27, 2024
50e76f9
Update constraints.md
mojtabafayyaz Dec 27, 2024
5bd77f6
Update learning_goals.md
mojtabafayyaz Dec 27, 2024
ee14234
Update README.md
mojtabafayyaz Dec 27, 2024
18b823a
Update README.md
mojtabafayyaz Dec 27, 2024
0ed4e4e
Update communication.md
mojtabafayyaz Dec 27, 2024
91b549e
Update constraints.md
mojtabafayyaz Dec 27, 2024
3708c50
Update learning_goals.md
mojtabafayyaz Dec 27, 2024
b89cfef
Update README.md
mojtabafayyaz Dec 27, 2024
4151a53
Update communication.md
mojtabafayyaz Dec 27, 2024
dd64639
Update constraints.md
mojtabafayyaz Dec 27, 2024
8cd066e
Update README.md
mojtabafayyaz Dec 27, 2024
5a2701c
Update README.md
mojtabafayyaz Dec 28, 2024
90bb967
Update README.md
mojtabafayyaz Dec 28, 2024
d9695f3
Update README.md
mojtabafayyaz Dec 28, 2024
203a711
Update README.md
mojtabafayyaz Dec 28, 2024
d39032f
Update communication.md
mojtabafayyaz Dec 28, 2024
c496d18
Update communication.md
mojtabafayyaz Dec 28, 2024
bb10f63
Update communication.md
mojtabafayyaz Dec 28, 2024
3b0da30
Update communication.md
mojtabafayyaz Dec 28, 2024
283d94f
Update communication.md
mojtabafayyaz Dec 28, 2024
ff00b8c
Update communication.md
mojtabafayyaz Dec 28, 2024
089bec4
Update communication.md
mojtabafayyaz Dec 28, 2024
b8b2cb5
Update constraints.md
mojtabafayyaz Dec 28, 2024
9f4155c
Update constraints.md
mojtabafayyaz Dec 28, 2024
313fbf4
Update constraints.md
mojtabafayyaz Dec 28, 2024
348f0ac
Update constraints.md
mojtabafayyaz Dec 28, 2024
a12fe50
Update constraints.md
mojtabafayyaz Dec 28, 2024
bf09e6a
Fixed_ constraints.md
mojtabafayyaz Dec 28, 2024
269f388
Merge branch 'main' into fixed-constraints
MadiMalik Dec 28, 2024
34efb40
Update README.md
mojtabafayyaz Dec 28, 2024
20a576b
Update README.md
mojtabafayyaz Dec 28, 2024
0e90e23
Update communication.md
mojtabafayyaz Dec 28, 2024
d81c819
Update README.md
mojtabafayyaz Dec 28, 2024
76b203d
Update constraints.md
mojtabafayyaz Dec 28, 2024
a7e7f64
Update constraints.md
mojtabafayyaz Dec 28, 2024
57e5be9
Update constraints.md
mojtabafayyaz Dec 28, 2024
257efaf
Update constraints.md
mojtabafayyaz Dec 28, 2024
1daa6e6
Update constraints.md
mojtabafayyaz Dec 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ share is a strong eagerness to learn. By the end of this project, we will no lon
be complete beginners.

We are learning collaboratively, growing through our mistakes, and working as a
team to improve. .
team to improve.
71 changes: 37 additions & 34 deletions collaboration/README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,73 @@
# Collaboration

<!-- group norms summary -->

## Summary of Norms

Our goal is to create a collaborative environment where everyone feels
comfortable asking questions and working together. We will start with the basics,
progress toward project goals, and remain respectful, helpful, and connected
throughout the journey.
<!-- group norms list -->
Our goal is to create a collaborative environment where everyone feels
comfortable asking questions and working together. We will start with
the basics, progress toward project goals, and remain respectful, helpful,
and connected throughout the journey.

### 1. Encourage Open and Respectful Communication

- Ensure all members feel heard and valued in discussions.
- Prioritize clear and constructive communication, encouraging everyone to share
their ideas and perspectives without fear of judgment or interruption.
- Ensure all members feel heard and valued in discussions.
- Prioritize clear and constructive communication, encouraging everyone
to share their ideas and perspectives without fear of judgment or
interruption.

### 2. Balance Discussion and Debate

- Promote productive collaboration through thoughtful discourse.
- Use discussions to generate ideas and debates to critically evaluate them while
maintaining respect and focusing on project goals.
- Promote productive collaboration through thoughtful discourse.
- Use discussions to generate ideas and debates to critically evaluate
them while maintaining respect and focusing on project goals.

### 3. Technical Meetings

- Use **Slack** for technical discussions and project updates.
- Use **Slack** for technical discussions and project updates.

- Use **WhatsApp** for urgent matters and quick clarifications.

### 4. Reminders for Code Review

- To ensure timely code reviews, feel free to send a friendly reminder on Slack
or WhatsApp when necessary.
- Encourage team members to notify the requester once the code review is completed.
- To ensure timely code reviews, feel free to send a friendly reminder
on Slack or WhatsApp when necessary.
- Encourage team members to notify the requester once the code review
is completed.

### 5. Handling Delays and Meeting Attendance

- Meetings will start as scheduled to respect everyone's time.
- If unable to attend, members should share their situation in advance and catch
up via recordings.
- Meetings will start as scheduled to respect everyone's time.
- If unable to attend, members should share their situation in advance
and catch up via recordings.

### 6. Maintain a Positive Team Environment

- Avoid rude or mean behavior.
- If any interaction causes discomfort, address it respectfully to resolve the
issue and foster understanding.
- Avoid rude or mean behavior.
- If any interaction causes discomfort, address it respectfully to resolve
the issue and foster understanding.

### 7. Create a Safe Feedback Culture

- Encourage constructive feedback to improve team performance.
- Encourage constructive feedback to improve team performance.

- Focus on solutions rather than blame when giving or receiving feedback.

### 8. Clear Handoffs When Required

- If there are delays in completing tasks, inform the team promptly to prevent
further delays.
- Minimize dependency issues by clearly communicating expectations and timelines
when tasks require input or dependencies from another member.
- If there are delays in completing tasks, inform the team promptly to
prevent further delays.
- Minimize dependency issues by clearly communicating expectations and
timelines when tasks require input or dependencies from another member.

### 9. Respect for Different Work Styles

- Foster individuality while ensuring progress.
- Respect that everyone has a unique working style, provided deliverables are
submitted on time and meet agreed standards.
- Foster individuality while ensuring progress.
- Respect that everyone has a unique working style, provided deliverables
are submitted on time and meet agreed standards.

### 10. Responsiveness and Accountability

- While everyone has different schedules, acknowledging messages on Slack or
WhatsApp—even with a brief reply—helps keep the team informed and connected.
- This ensures smooth collaboration and demonstrates respect for everyone’s efforts.
- While everyone has different schedules, acknowledging messages on
Slack or WhatsApp—even with a brief reply—helps keep the team
informed and connected.
- This ensures smooth collaboration and demonstrates respect for
everyone’s efforts.
141 changes: 24 additions & 117 deletions collaboration/communication.md
Original file line number Diff line number Diff line change
@@ -1,135 +1,42 @@
<!--
This template is for inspiration. Feel free to change it however you like!

Careful! Be sure to protect your privacy when filling out this document.
Everything you write here will be public, so share only what you are
comfortable sharing online. You can share the rest in confidence with your
group by another channel.
-->
# Communication Channels

# Communication Plan
How often will we get in touch on each channel, and what we will discuss there:

## Communication Schedule

This is the schedule for each week, and it will be updated weekly.

| Day | How | The topic of discussion |
|-----------|:----:|-------------------------------------------|
| Monday | Zoom | |
| Tuesday | Zoom | |
| Wednesday | Zoom | GitHub Issues and Pull Request Discussion |
| Thursday | Zoom | |
| Friday | Zoom | |
| Saturday | Zoom | |
| Sunday | Zoom | |
- **Issues**: Adding availability to the schedule.
- **Pull Requests**: Reviewing each other's code and giving feedback.
- **Slack/Discord**: Email, Slack, and WhatsApp.
- **Video Calls**: Zoom and Google Meet.

---

## Communication Channels

Check failure on line 13 in collaboration/communication.md

View workflow job for this annotation

GitHub Actions / md_formatting

Multiple consecutive blank lines [Expected: 1; Actual: 2]

Check failure on line 13 in collaboration/communication.md

View workflow job for this annotation

GitHub Actions / md_formatting

Multiple consecutive blank lines [Expected: 1; Actual: 2]
All technical discussions will be conducted on Slack. General discussions will
use WhatsApp.

- **Issues**: Adding availability to the schedule
- **Pull Requests**: Reviewing each other's code and giving feedback
- **Slack/Discord**: Email, Slack, and WhatsApp
- **Video Calls**: Zoom and Google Meet

---

## Availability

### Availability for Calling/Messaging

Check failure on line 17 in collaboration/communication.md

View workflow job for this annotation

GitHub Actions / md_formatting

Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]

Check failure on line 17 in collaboration/communication.md

View workflow job for this annotation

GitHub Actions / md_formatting

Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
<!-- Ignored the max line length cause it it looks good in this way -->
| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday|
|------------|:------:|:-------:|:---------:|:--------:|:------:|:--------:|:------:|
| **Madiha** | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |

| **Fatima** | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |

| **Shahroz**| ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |

### Hours Available Per Day

- **Fatima**: _5h_
- **Madiha**: _5h_
- **M Shahroz**: _4h_
- **Member 2**: _4h_
- **Member 3**: _3h_

---

## Meeting Agendas and Records

### Previous Meetings

#### Meeting 1
| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday|
|--------|:------:|:-------:|:---------:|:--------:|:------:|:--------:|:------|
| **Madiha** | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓|
| **Shahroz**| ✓| ✓ | ✓ | ✓ | | ✓ | ✓ |

- **Date:** 20-12-2024
- **Discussion Topics:**
- Introduction
- Team Norms
- Strategies for tackling the project
- **Decisions Made:**
- Decided on 7 team norms.
- Study Google Documents.
### How Many Hours Everyone Has Per Day

#### Meeting 2

- **Date:** 21-12-2024
- **Discussion Topics:**
- Finalizing group norms
- Team name
- **Decisions Made:**
- Finalized 10 norms.
- Decided on the team name: "Git it Done."
- First commit made on GitHub.

#### Meeting 3

- **Date:** 22-12-2024
- **Discussion Topics:**
- Discussion on assigned Google Docs
- Guiding new team members
- **Decisions Made:**
- Official work to start tomorrow.

#### Meeting 4

- **Date:** 23-12-2024
- **Discussion Topics:**
- Pull requests
- Branches
- **Decisions Made:**
- Tasks assigned to each team member.
- Explore more about pull requests and branches.
- Explore issues on GitHub.

---

### Upcoming Meetings

#### Meeting 5

- **Date:** 25-12-2024
- **Discussion Topics:**
- [Point 1]
- [Point 2]
- **Decisions Made:**
- [Decision 1]
- [Decision 2]
**Action Items:**
- [Action 1]
- [Action 2]

---
- **Shahroz**: 4h.
- **[Name]**: 6h.
- **Madiha**: 5h.
- **[Name]**: 4h.
- **[Name]**: 3h.

## Asking for Help

There's a fine line between confidently learning from your mistakes and
stubbornly getting nowhere. Here is a general guide for when to ask for help
based on how long you've been stuck on the same problem:
There's a fine line between confidently learning from your mistakes
and stubbornly
getting nowhere. 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
2. _30 -> 60 min_: Ask your group for help
3. _60+ min_: Tag your coaches in Slack or GitHub
1. _0 30 min_: Try on your own.
2. _30 60 min_: Ask your group for help.
3. _60+ min_: Tag your coaches in Slack or GitHub.
63 changes: 32 additions & 31 deletions collaboration/constraints.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
<!-- This template is for inspiration, feel free to change it however you like! -->

# Constraints

This section outlines the boundaries and considerations for our project to ensure
smooth collaboration, efficient learning, and effective task completion.
This section outlines the boundaries and considerations for our project
to ensure smooth collaboration, efficient learning, and effective task completion.

## External Constraints

<!--
Constraints coming from the outside that your team has no control over:
- Project deadlines
- Number of unit tests required to pass a code review
- Technologies (sometimes a client will tell you what to use)
- Power or connectivity
- project deadlines
- number of unit tests required to pass a code review
- technologies (sometimes a client will tell you what to use)
- power or connectivity
- ...
-->

Expand All @@ -21,29 +19,30 @@
- **Platform Requirements:**
- Problems must be selected from the workshop's exercises, CodeWars, LeetCode,
or similar coding platforms.
- Solutions must comply with the workshop's requirements (e.g., unittest,

- Solutions must comply with the workshop's requirements (e.g., unit tests,
documentation, and clear variable names).

- **Deadlines:**
- Projects must be completed within the timeline set by the MIT Emerging Talent
program.
- Each member must solve and review problems within the agreed-upon time frames.
- Projects must be completed according to the timeline set by the MIT Emerging
Talent program.
- Each member must solve and review problems within the agreed-upon timeframes.

- **Tools and Resources:**
- GitHub must be used for version control, communication, and documentation.
- The team must rely on publicly available resources (e.g., online tutorials
and documentation) to enhance learning.
- The team must rely on publicly available resources (e.g., online tutorials and
documentation) to enhance learning.


Check failure on line 36 in collaboration/constraints.md

View workflow job for this annotation

GitHub Actions / md_formatting

Multiple consecutive blank lines [Expected: 1; Actual: 2]

Check failure on line 36 in collaboration/constraints.md

View workflow job for this annotation

GitHub Actions / md_formatting

Multiple consecutive blank lines [Expected: 1; Actual: 2]
## Internal Constraints: Involuntary

<!--
Constraints that come from within your team, and you have no control over:
- Each of your individual skill levels
- Amount of time available to work on the project
- each of your individual skill levels
- amount of time available to work on the project
-->

**These are limitations or challenges within the team that we need to navigate
effectively.**
**These are limitations or challenges within the team that we need to navigate effectively.**

- **Experience Levels:**
- Team members have varying levels of experience in programming, unit testing,
Expand All @@ -61,22 +60,23 @@
## Internal Constraints: Voluntary

<!--
Constraints that your team decided on to help scope the project. They may
include:
- Coding style & conventions
- Agree on a code review checklist for the project repository
- The number of hours you want to spend working
- Only using the colors black and white
Constraints that your team decided on to help scope the project.
They may include:
- coding style & conventions
- agreeing on a code review checklist for the project repository
- the number of hours you want to spend working
- only using the colors black and white
-->

**These are self-imposed rules or boundaries designed to improve collaboration and
learning outcomes.**
**These are self-imposed rules or boundaries designed to improve collaboration
and learning outcomes.**

- **Unit Testing:**
- All submitted solutions must include unit tests to verify correctness and
edge cases.
- Use Python’s unittest module (or equivalent) for testing.
- All submitted solutions must include unit tests to verify correctness and edge
cases.
- Use Python’s `unittest` module (or equivalent) for testing.


Check failure on line 79 in collaboration/constraints.md

View workflow job for this annotation

GitHub Actions / md_formatting

Multiple consecutive blank lines [Expected: 1; Actual: 2]

Check failure on line 79 in collaboration/constraints.md

View workflow job for this annotation

GitHub Actions / md_formatting

Multiple consecutive blank lines [Expected: 1; Actual: 2]
- **Documentation Standards:**
- All code must include meaningful comments explaining the logic.
- Problem solutions must include documentation with:
Expand All @@ -92,5 +92,6 @@
- **Collaborative Learning:**
- Each member must share insights or challenges they faced during problem-solving
to help others learn.
- Regular check-ins (via GitHub comments or virtual meetings) to ensure
alignment.

- Regular check-ins (via GitHub comments or virtual meetings) to ensure alignment.

Loading
Loading