Skip to content

Commit

Permalink
Merge pull request #21 from MIT-Emerging-Talent/update-templates
Browse files Browse the repository at this point in the history
Update templates
  • Loading branch information
mojtabafayyaz authored Dec 28, 2024
2 parents 2ef9862 + bd0aef0 commit 8d9d759
Show file tree
Hide file tree
Showing 10 changed files with 221 additions and 92 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/help_wanted.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ labels: "help wanted"
- assign: anyone you would like help from
-->

## The Code
# The Code

<!--
The code you have a question about (it doesn't need to be your code!). This can
Expand Down
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/new_challenge.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ about: >
-->

<!--
Describe the challenge's _behavior_ so someone can start solving it without asking for clarification.
Describe the challenge's _behavior_ so someone can start solving it without
asking for clarification.
Do not describe a _strategy_ or an _implementation_!
Others are free to solve the behavior however they like.
-->
Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
MIT License
# MIT License

Copyright (c) 2024 MIT Emerging Talent

Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
# Git it Done

## Overview

Welcome to the **Git it Done** repository!

This is a collaborative learning project where our team works together to solve problems and learn new skills. Each teammate will:
This is a collaborative learning project where our team works together to solve
problems and learn new skills. Each teammate will:

- Solve 2 problems.
- Help resolve 2 problems contributed by others.

Our team is made up of people with different levels of experience—some of us are complete beginners, while others have a little experience. But one thing we all share is a strong eagerness to learn. By the end of this project, we will no longer be complete beginners.
Our team is made up of people with different levels of experience—some of us are
complete beginners, while others have a little experience. But one thing we all
share is a strong eagerness to learn. By the end of this project, we will no longer
be complete beginners.

We are learning collaboratively, growing through our mistakes, and working as a team to improve. .
We are learning collaboratively, growing through our mistakes, and working as a
team to improve. .
48 changes: 34 additions & 14 deletions collaboration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,48 +3,68 @@
<!-- 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.

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 -->

### 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.
- 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.
- 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 **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.
- 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.
- 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.
- 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.
149 changes: 114 additions & 35 deletions collaboration/communication.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,135 @@
<!--
this template is for inspiration, feel free to change it however you like!
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 you group by another channel
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

______________________________________________________________________
# Communication Plan

## Communication Schedule

| Day | How | The topic of discussion | | --- | :-: | ----------------------- |
| | | |

## Communication Channels

how often will we get in touch on each channel, and what we will discuss there:
This is the schedule for each week, and it will be updated weekly.

- **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
| 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 | |

______________________________________________________________________
---

## Availability
## Communication Channels

### Availability for calling/messaging
All technical discussions will be conducted on Slack. General discussions will
use WhatsApp.

| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday | |
------ | :----: | :-----: | :-------: | :------: | :----: | :------: | :----: |
**Madiha**| Monday &check;| Tuesday &check;| Wednesday &check;| Thursday &check;| Friday &check;| Saturday &check;| Sunday &check;| |
- **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

**Shahroz**| Monday &check;| Tuesday &check;| Wednesday &check;| Thursday &check;| Sunday &check;| |
---

### How many hours everyone has per day
## Availability

- Shahroz: _4h_;
- name: _6h_;
- Madiha: _5h_;
- name: _4h_;
- name: _3h_;
### Availability for Calling/Messaging
<!-- 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

- **Date:** 20-12-2024
- **Discussion Topics:**
- Introduction
- Team Norms
- Strategies for tackling the project
- **Decisions Made:**
- Decided on 7 team norms.
- Study Google Documents.

#### 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]

---

## Asking for Help

There's a fine line between confidently learning from your mistakes, and
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
1. _30 -> 60 min_: Ask your group for help
1. _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
Loading

0 comments on commit 8d9d759

Please sign in to comment.