forked from MIT-Emerging-Talent/ET6-practice-code-review
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #21 from MIT-Emerging-Talent/update-templates
Update templates
- Loading branch information
Showing
10 changed files
with
221 additions
and
92 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
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
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
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,4 +1,4 @@ | ||
MIT License | ||
# MIT License | ||
|
||
Copyright (c) 2024 MIT Emerging Talent | ||
|
||
|
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,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. . |
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
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,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 ✓| Tuesday ✓| Wednesday ✓| Thursday ✓| Friday ✓| Saturday ✓| Sunday ✓| | | ||
- **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 ✓| Tuesday ✓| Wednesday ✓| Thursday ✓| Sunday ✓| | | ||
--- | ||
|
||
### 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 |
Oops, something went wrong.