diff --git a/README.md b/README.md index e69de29bb..2c2a7c791 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,126 @@ +# MIT Avatars + +![Team Work](assets/team-work.jpg) + +Welcome to the **MIT Avatars** repository! This is where our group collaborates, +learns, and grows together by solving Python challenges, sharing knowledge, and +developing innovative coding solutions. + +--- + +## 👥 Meet the Team + +We’re a group of passionate and diverse learners united by a love for coding and +problem-solving. Here's a brief introduction to our team members: + +- **Aseel 🎯** + *Fun Fact:* "I love playing Sudoku—it’s like a workout for my brain!" + +- **Ameen 🏉** + *Fun Fact:* "I am a professional rugby player. I play professional rugby nationally + in Lebanon and represent Palestine internationally." + +- **Maria ✈️** + *Fun Fact:* "I love traveling as much as I love food – the only difference + is, one fills my passport and the other fills my stomach!" + +- **Muhannad 🧑🏻‍💻** + *Fun Fact:* "When I feel lost in the maze of learning, I just hit the 'code' button + because nothing finds the way like programming!" + +- **Maher 🛣️** + *Fun Fact:* "I really like playing rugby." + +- **Malak ❇️** + *Fun Fact:* "I look for purpose in almost everything I do." + +- **Abdulrahman 🕊** + *Fun Fact:* "I'm a medical student who codes and leads teams—blending science, + tech, and leadership in a unique way! I also love cats." + +--- + +## 📌 Purpose of this Repository + +This repository is our collaborative space for: + +- 📝 **Sharing Python challenges:** Post interesting problems and work together + on solutions. +- 💡 **Collaborating on innovative solutions:** Share diverse approaches and + refine them. +- 📚 **Documenting our learning journey:** Note lessons learned and best practices. + +--- + +## 🚀 Getting Started + +Here’s how to get involved and contribute: + +### 1️⃣ Fork the Repository + +Click the **Fork** button at the top-right of this page to create your copy of +the repository. + +### 2️⃣ Create an Issue + +Navigate to the **Issues** tab and submit an issue describing the challenge. + +### 3️⃣ Work on the Challenge + +Clone the repository to your local machine using: + +```bash +git clone https://github.com/YOUR-USERNAME/ET6-foundations-group-17.git +``` + +Create a new branch for your work: + +```bash +git checkout -b feature/your-feature-name +``` + +### 4️⃣ Submit Your Work + +Push your changes to the branch: + +```bash +git add . +git commit -m "Description of changes" +git push origin feature/your-feature-name +``` + +Finally, open a pull request and wait for feedback from your team. + +--- + +## 🌟 Code of Conduct + +To foster a welcoming and collaborative environment: + +- Be respectful and constructive in your feedback. +- Share knowledge and support each other. +- Embrace diversity in ideas and approaches. + +--- + +## 🛠️ Tech Stack + +This repository uses: + +- **Python:** Our primary programming language for solving challenges. +- **Git/GitHub:** For version control and collaboration. + +--- + +## 🎯 Goals + +As the MIT Avatars, we aim to: + +- Strengthen our problem-solving skills. +- Enhance our Python proficiency. +- Build a supportive and creative learning community. +- Make it to the MIT program as a team. + +🔗 **Group Repository:** +Check out our repository: +[MIT-Emerging-Talent/ET6-foundations-group-17](https://github.com/MIT-Emerging-Talent/ET6-foundations-group-17) diff --git a/assets/team-work.jpg b/assets/team-work.jpg new file mode 100644 index 000000000..83f556c56 Binary files /dev/null and b/assets/team-work.jpg differ diff --git a/collaboration/README.md b/collaboration/README.md index 20889b951..dbeba4a57 100644 --- a/collaboration/README.md +++ b/collaboration/README.md @@ -1,5 +1,110 @@ # Collaboration - +## Group Norms - +Group norms are the shared values, rules, and expectations that guide our +behavior, communication, and interactions within the team. By establishing clear +norms, we aim to create an inclusive, productive, and collaborative environment +where every member feels valued and empowered. Our team thrives on openness, +respect, and the shared belief that collaboration makes us stronger. + +## Core Principles + +### Respect and Inclusivity + +- Acknowledge and appreciate the diverse backgrounds, perspectives, and +contributions of all team members. +- Foster a safe space for open expression, where constructive feedback is +encouraged, and differing opinions are welcomed. + +### Clear Communication + +- Use clear, concise, and respectful language in all communications. +- Prioritize active listening during discussions and avoid interrupting others. +- Clarify misunderstandings promptly and assume good intentions when +interpreting messages. + +### Collaboration and Teamwork + +- Share responsibilities and ensure equitable participation in tasks. +- Support each other by sharing knowledge, offering help, and celebrating +achievements. +- Commit to resolving conflicts constructively and collaboratively. + +### Accountability and Commitment + +- Take responsibility for completing assigned tasks on time and to the best of +your ability. +- Communicate proactively about challenges or delays to ensure transparency. +- Honor commitments made to the group and follow through on agreements. + +### Adaptability and Growth + +- Be open to feedback and willing to make improvements based on team discussions +- Embrace flexibility in adapting to new tools, workflows, or ideas introduced +by the group. +- Commit to ongoing learning and professional development as a team. + +## Norms in Practice + +### Communication Norms + +- Utilize team communication platforms (e.g., Slack, GitHub, Whatsapp, or email) +for updates, questions, and discussions. +- Maintain professionalism in all written and verbal interactions. +- Schedule regular check-ins or stand-ups to monitor progress and address +concerns. + +### Collaboration Norms + +- Use shared tools like GitHub for version control, task assignments, and +documentation. +- Follow branch naming conventions and adhere to agreed processes for code +reviews. +- Complete the collaboration/retrospective.md document at the end of the project +to reflect on successes and areas for improvement. + +### Conflict Resolution + +- Approach conflicts with a mindset of dialogue rather than debate. +- Use "I" statements to express concerns constructively (e.g., "I feel X when Y +happens"). +- Seek input from the group or a mediator if conflicts cannot be resolved +independently. + +### Meeting Norms + +- Start and end meetings on time, with a clear agenda and objectives. +- Ensure everyone has an opportunity to speak and contribute. +- Summarize key takeaways and action items at the end of each meeting. + +### Inclusion Norms + +- Be mindful of language barriers or time zone differences when scheduling +meetings or assigning tasks. +- Rotate leadership roles for tasks or meetings to ensure equitable +participation. +- Celebrate cultural diversity by sharing customs, holidays, or traditions +during appropriate occasions. + +### Group Norms Summary + +- Feedback is given constructively, aiming to improve ideas rather than +criticize individuals. +- We communicate transparently and ensure all intentions are clear, fostering +trust among the team. +- If someone doesn’t have an answer, they openly admit it, and we work together +to find solutions. +- Concerns or ideas are raised immediately, ensuring smooth progress without +unnecessary delays. +- Every contribution is valuable, and all ideas are treated with respect and +consideration. +- Personal attacks are off-limits; we engage respectfully, focusing on ideas +rather than people. + +## Ongoing Evolution + +Group norms are not static. We commit to revisiting and updating these norms +based on feedback, changing circumstances, and lessons learned from our +collaborative experiences. By aligning with these norms, we aim to foster a +supportive team culture that enables high performance and mutual growth. diff --git a/collaboration/communication.md b/collaboration/communication.md index 484652e0f..04088a940 100644 --- a/collaboration/communication.md +++ b/collaboration/communication.md @@ -1,54 +1,63 @@ - - # Communication -______________________________________________________________________ - ## Communication Schedule -| Day | How | The topic of discussion | | --- | :-: | ----------------------- | -| | | | +| Date | Day | How | The topic of discussion | +|-----------|------------|------|--------------| +| Dec. 20th ✅ | Friday | Zoom meeting | Getting to know team members | +| Dec. 23rd ✅ | Monday | Google Meet | Collaboratively exploring the group repo.| +| Dec. 26th ✅ | Thursday | Google Meet |Collaboration folder and its files| +| Jan. 2nd ✅ | Thursday | Google Meet | Final meeting for the collaboration folder| +| Jan. 4th ✅ | Saturday | Zoom Online Meeting | Problems Delivery | +| Jan. 6th ✅ | Monday | GitHub | Review Session | +| Jan. 8th ✅| Wednesday | GitHub | Challenges Delivery Deadline | +| Jan. 9th ✅| Tuesday | GitHub | Reviews Deadline | +| Jan. 11th | Saturday | Zoom Online Meeting | Retrospective | ## Communication Channels -how often will we get in touch on each channel, and what we will discuss there: - -- **Issues**: -- **Pull Requests**: -- **Slack/Discord**: -- **Video Calls**: +How often will we get in touch on each channel, and what we will discuss there: -______________________________________________________________________ +- **Issues**: Used as needed to track tasks, discuss challenges, or document ideas. + Team members should also check for updates on a daily basis. +- **Pull Requests**: Created whenever code is ready for review. All team members + should aim to review PRs within 24-48 hours. +- **Slack/WhatsApp**: Active daily for quick updates, questions, and informal discussions. +- **Video Calls**: Scheduled every 3 days to discuss progress, address blockers, + and align on upcoming tasks. ## Availability ### Availability for calling/messaging -| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday | | ------- | :----: | :-----: | :-------: | :------: | :----: | :------: | :----: | -| _name_ | | | | | | | | +| Name/Day | Sunday | Monday | Tuesday | Wednesday| Thursday | Friday | Saturday| +|--------------|--------|---------|----------|----------|--------|-------|------| +| Malak Battatt| 5-8PM| 5-8PM | 5-8PM | 5-8PM |3-6PM | 2-4PM| 2-5PM | +| Abdulrahman Alsir| 7-9PM| 2-5PM | 4-8PM | 7-9PM | 7-9PM | 6-8PM | 6-8PM | +| Ameen Agha| 2-6PM| 2-6PM | 2-6PM | 2-6PM | 2-6PM | 2-6PM| 2-6PM| +| Aseel AbuKmail| 7-10PM| 2-5PM | 5-8PM | 5-7PM | 7-9PM | 6-10PM | 6-8PM | +| Maher Assaf | 4-7PM| 4-7PM | 6-7PM | 7-8PM | 7-9PM | 6-8PM | 6-8PM | +| Maria Roufail | 4-7PM| 4-7PM | 6-7PM | 7-8PM | 7-9PM | 6-8PM | 6-8PM | +| Muhannad Assaf | 4-7PM| 4-7PM | 6-7PM | 7-8PM | 7-9PM | 6-8PM | 6-8PM | +| Rouaa Hamzah | 4-7PM| 4-7PM | 4-7PM | 4-7PM | 7-9PM | 7-9PM| 7-9PM| ### How many hours everyone has per day -- name: _5h_; -- name: _6h_; -- name: _5h_; -- name: _4h_; -- name: _3h_; +- Malak Battatt: _~2-4h_; +- Abdulrahman Alsir: _~2-4h_; +- Ameen Agha: _~2-4h_; +- Aseel AbuKmail: _~2-4h_; +- Maher: _~2h_; +- Maria: _~2h_; +- Muhannad: _~2h_; +- Rouaa: _~2h_; ## Asking for Help There's a fine line between confidently learning from your mistakes, and -stubbornly getting no where. Here is a general guide for when to ask for help +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 +2. _30 -> 60 min_: Ask your group for help +3. _60+ min_: Tag your coaches in Slack or GitHub diff --git a/collaboration/constraints.md b/collaboration/constraints.md index 24079505c..ead4ac343 100644 --- a/collaboration/constraints.md +++ b/collaboration/constraints.md @@ -2,29 +2,47 @@ # Constraints -Some boundaries around our project. - -## External - - +## External Constraints + +- **Deadline:** The project must be finished by January 10th. +- **Connectivity Issues:** Limited internet access affects some teammates, +especially during peak hours. +- **Holiday Availability:** Team members celebrating Christmas may have fewer +hours to contribute this week. +- **Time Zone Differences:** Team members located in different time zones may +face scheduling conflicts. +- **Resource Limitations:** Access to high-performance computers or specific +software licenses may be restricted for some members. +- **Childcare Responsibilities:** Some team members need to take care of their children. ## Internal: Involuntary - +- **Students:** Managing their time between this project and their final exams. +- **GitHub Workflows:** Some team members are new to GitHub workflows and may +need extra guidance. +- **English Fluency:** Limited fluency in English among some members might make +it harder to express complex ideas or provide detailed feedback during +discussions. +- **Team Composition:** Uneven distribution of technical skills among team +members may create bottlenecks for specific tasks. +- **Health and Well-being:** Some members may have personal health issues or +responsibilities that could affect their availability. +- **Knowledge Gaps:** Some team members may lack experience with certain tools + or frameworks required for the project, leading to delays. ## Internal: Voluntary +- Agreed Coding Standards and Conventions (Naming conventions, Comment style) +- Code Review Checklist for the Project Repository +- Number of Hours Team Members Want to Spend Working +- Limiting the Scope to specific design choices (e.g., only using black and +white colors) +- **Communication Protocols:** +The team has agreed to use specific tools (e.g., Slack, Zoom) for coordination +and discussions. +- **Review Policies:** +Each pull request must be reviewed by at least two members before merging. +