forked from MIT-Emerging-Talent/ET6-practice-code-review
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Since code would refuse to upload, I am uploading the full directory branch again with tests and code and creating my own branch
- Loading branch information
Showing
96 changed files
with
2,796 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 MIT Emerging Talent | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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 |
---|---|---|
@@ -0,0 +1,143 @@ | ||
# Coding Pioneers United - Team repository | ||
|
||
![technology Python](https://img.shields.io/badge/technology-python-blue.svg) | ||
|
||
Welcome to our team! Our group thrives on mutual trust, open communication, and | ||
respect, fostering a collaborative environment where every member’s ideas and | ||
contributions are valued. We aim to work efficiently and harmoniously by balancing | ||
creativity and critical thinking, supporting one another to achieve our shared goals | ||
while maintaining a culture of accountability and care. | ||
|
||
## Meet the team | ||
|
||
<!-- markdownlint-disable MD033 --> | ||
<table> | ||
<thead> | ||
<tr> | ||
<th></th> | ||
<th><strong>Name</strong></th> | ||
<th><strong>GitHub</strong></th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td> | ||
<img src="https://avatars.githubusercontent.com/u/189562848?v=4" | ||
alt="Ana Isabel Murillo" width="65"> | ||
</td> | ||
<td>Ana Isabel Murillo</td> | ||
<td><a href="https://github.com/AnaiMurillo">AnaiMurillo</a></td> | ||
</tr> | ||
<td> | ||
<img src="https://avatars.githubusercontent.com/u/189357565?v=4" | ||
alt="Adolfo Fumero" width="65"> | ||
</td> | ||
<td>Adolfo Fumero</td> | ||
<td><a href="https://github.com/ajfumero8">ajfumero8</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/174089681?v=4" | ||
alt="Mr-Glucose" width="65"></td> | ||
<td>Arthur Dorvil</td> | ||
<td><a href="https://github.com/Mr-Glucose">Mr-Glucose</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/188538629?v=4" | ||
alt="Chrismy Augustin" width="65"></td> | ||
<td>Chrismy Augustin</td> | ||
<td><a href="https://github.com/likechrisss">likechrisss</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/92646899?v=4" | ||
alt="Cliforde Exael" width="65"></td> | ||
<td>Cliforde Exael</td> | ||
<td><a href="https://github.com/Lastrophysicien">Lastrophysicien</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/115899276?v=4" | ||
alt="Hector Colmenares" width="65"></td> | ||
<td>Hector Colmenares</td> | ||
<td><a href="https://github.com/hectordacb">hectordacb</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/189242306?v=4" | ||
alt="Jeampierr Jiménez" width="65"></td> | ||
<td>Jeampierr Jiménez</td> | ||
<td><a href="https://github.com/Jeampierr1102">Jeampierr1102</a></td> | ||
</tr> | ||
<td> | ||
<img src="https://avatars.githubusercontent.com/u/189233851?v=4" | ||
alt="Pierre Kenley MERVIL" width="65"> | ||
</td> | ||
<td>Pierre Kenley MERVIL</td> | ||
<td><a href="https://github.com/MPKenley">MPKenley</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/86928180?v=4" | ||
alt="Ramon Colmenares" width="65"></td> | ||
<td>Ramon Colmenares</td> | ||
<td><a href="https://github.com/RamonColmenares">RamonColmenares</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/189634607?v=4" | ||
alt="Semira Tesfai" width="65"></td> | ||
<td>Semira Tesfai</td> | ||
<td><a href="https://github.com/SEMIRATESFAI">SEMIRATESFAI</a></td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
<!-- markdownlint-enable MD033 --> | ||
|
||
## Project Progress | ||
|
||
We track our progress using the | ||
[GitHub Kanban Board](https://github.com/orgs/MIT-Emerging-Talent/projects/104). | ||
Here's a quick look at our board in action: | ||
|
||
![Kanban Board Preview](assets/kabanboard04.gif) | ||
|
||
## Technologies & Tools 🛠️ | ||
|
||
- **Languages:** Python | ||
- **Frameworks/Libraries:** Unittest | ||
- **Documentation:** Markdown | ||
- **Version Control:** Git, GitHub | ||
- **Other Tools:** VS Code | ||
|
||
## Getting Started 🚀 | ||
|
||
Before cloning this repository, make sure you have Git | ||
installed and are signed into your GitHub account. | ||
|
||
### Clone the Repository | ||
|
||
1. Open your terminal (Command Prompt, Git Bash, or terminal of choice). | ||
|
||
2. Clone the repository using either SSH or HTTPS. | ||
|
||
**Using SSH**: | ||
|
||
```bash | ||
git clone [email protected]:MIT-Emerging-Talent/ET6-foundations-group-04.git | ||
``` | ||
|
||
### Run the Tests | ||
|
||
1. Open your terminal (Command Prompt, Git Bash, or terminal of choice). | ||
|
||
2. Navigate to the project directory: | ||
|
||
```bash | ||
cd ET6-foundations-group-04 | ||
``` | ||
|
||
3. Run the tests using: | ||
|
||
```bash | ||
python -m unittest | ||
``` | ||
|
||
## Contributing | ||
|
||
Please refer to our [Contributing Guide](CONTRIBUTING.md) for information | ||
on how to contribute to this project. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,104 @@ | ||
# Coding Pioneers United | ||
|
||
## SUMMARY | ||
|
||
Welcome to our team!! Our group thrives on mutual trust, open communication, | ||
and respect, fostering a collaborative environment where every member’s ideas | ||
and contributions are valued. We aim to work efficiently and harmoniously by | ||
balancing creativity and critical thinking, supporting one another to achieve | ||
our shared goals while maintaining a culture of accountability and care. | ||
|
||
## NORMS LIST | ||
|
||
### Building and Maintaining Cognitive & Affective Trust | ||
|
||
1. **Reliability:** Set clear expectations, meet deadlines, and demonstrate | ||
competence in tasks to build cognitive trust. | ||
2. **Empathy:** Actively show empathy, listen without judgment, and celebrate | ||
individual and team achievements to foster affective trust. | ||
3. **Open Communication:** Communicate openly, honestly, and respectfully. | ||
Share concerns early and constructively. | ||
4. **Shared Knowledge:** Promote mutual learning by sharing knowledge and being | ||
open to new ideas. | ||
5. **Accountability:** Take responsibility for your tasks. Ask for help when | ||
needed and ensure all contributions align with team goals. | ||
6. **Respectful Listening:** Value everyone’s input by listening without | ||
interrupting and acknowledging diverse perspectives. | ||
7. **Inclusivity:** Create a safe space for honest communication and ensure | ||
equal opportunities for all members to contribute. | ||
8. **Feedback and Recognition:** Offer constructive feedback focused on the | ||
issue, not the individual. Celebrate successes and recognize contributions | ||
regularly. | ||
9. **Adaptability:** Stay flexible and open to change, adapting strategies as | ||
needed to overcome challenges. | ||
|
||
### Rebuilding Trust if Damaged | ||
|
||
1. Address issues openly and respectfully in a private setting to avoid | ||
unnecessary tension. | ||
2. Apologize sincerely if at fault and outline steps to prevent future issues. | ||
Be willing to forgive and move forward together. | ||
3. Acknowledge and discuss the root cause of the issue without defensiveness or | ||
blame. | ||
4. Reestablish or revise group norms and expectations to ensure alignment | ||
moving forward. | ||
5. Encourage open, transparent communication to allow everyone to express | ||
concerns and feelings. | ||
6. If necessary, seek third-party mediation for fair and impartial resolution. | ||
|
||
### Balancing Discussion and Debate | ||
|
||
1. Use discussions to explore ideas, brainstorm, and align on shared | ||
understanding. | ||
2. Transition to debates when decisive action or resolution of differing | ||
viewpoints is needed, ensuring structured and goal-oriented exchanges. | ||
3. Maintain respect and active listening in both discussion and debate to | ||
ensure inclusivity and productivity. | ||
|
||
### Approaching Meetings and Agendas | ||
|
||
1. Schedule meetings at times accommodating all members, considering personal | ||
and cultural commitments. | ||
2. Share agendas at least 24 hours in advance, outlining topics, goals, and | ||
time allocations. | ||
3. Assign rotating roles such as facilitator, note-taker, and timekeeper to | ||
share responsibilities. | ||
4. Start and end meetings on time. Review decisions and action items before | ||
closing. | ||
5. Use tools like Slack or Google Calendar to coordinate meeting times | ||
effectively. | ||
|
||
### Communication Channels | ||
|
||
1. Use group chat platforms (e.g., Slack) for progress updates, announcements, | ||
and casual discussions. | ||
2. Document and share important updates in centralized platforms like Google | ||
Drive or Notion for accessibility. | ||
3. Utilize video calls for in-depth discussions and synchronous collaboration. | ||
|
||
### Respect and Disrespect | ||
|
||
#### What Makes You Feel Respected | ||
|
||
1. Active listening without interruption. | ||
2. Timely and constructive feedback. | ||
3. Public acknowledgment of contributions. | ||
4. Adhering to agreed-upon norms and deadlines. | ||
|
||
#### What Makes You Feel Disrespected | ||
|
||
1. Interrupting or dismissing ideas. | ||
2. Ignoring norms or responsibilities. | ||
3. Condescending tone or language. | ||
4. Excluding team members from important discussions. | ||
|
||
### Additional Considerations | ||
|
||
1. **Feedback Culture:** Establish regular check-ins to share constructive | ||
feedback in a supportive manner. | ||
2. **Well-Being:** Respect work-life boundaries and monitor signs of burnout. | ||
3. **Stress Management:** Offer support and adjust workloads when teammates are | ||
overwhelmed. | ||
4. **Celebrations:** Celebrate milestones and accomplishments to boost morale. | ||
5. **Accountability Systems:** Use tools to track progress and individual | ||
contributions transparently. |
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 |
---|---|---|
@@ -0,0 +1,71 @@ | ||
<!-- | ||
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 | ||
--> | ||
|
||
<!-- markdownlint-disable MD013 --> | ||
# Communication | ||
|
||
______________________________________________________________________ | ||
|
||
## Communication Schedule | ||
|
||
| **Date** | **Time (EST)** | **Platform** | **Agenda** | | ||
|-------------------------------|----------------|----------------|-----------------------------------------------------------------------------| | ||
| Sunday, December 22nd | 9 AM | Google Meet | - Discuss and vote on team name ideas. - Establish guidelines for collaboration and communication. - Review and decide on tools for efficient teamwork. - Plan action items and next milestones. | | ||
| Friday, December 27th | 5 PM | Google Meet | - Review the collaboration tools document synchronously. - Discuss and propose challenges. - Solve any doubts or blockages we may have. | | ||
|
||
______________________________________________________________________ | ||
|
||
## Communication Channels | ||
|
||
how often will we get in touch on each channel, and what we will discuss there: | ||
|
||
| **Channel** | **Purpose** | **Frequency** | | ||
|-------------------|----------------------------------------------------------------------|-----------------------------------| | ||
| **Issues** | Report and discuss bugs, tasks, and enhancements. | On Demand | | ||
| **Pull Requests** | Review and discuss code changes before they are merged. | On Demand | | ||
| **Slack** | Quick questions, informal discussions, and real-time updates. | On Demand | | ||
| **Video Calls** | Discuss complex issues, planning meetings, and team sync-ups. | On Demand | | ||
|
||
______________________________________________________________________ | ||
|
||
## Availability | ||
|
||
### Availability for calling/messaging | ||
|
||
| **Team Member** | **Monday** | **Tuesday** | **Wednesday** | **Thursday** | **Friday** | **Saturday** | **Sunday** | | ||
|--------------------------|--------------|---------------|---------------|---------------|---------------|-----------------|----------------| | ||
| **Ramon Colmenares** | 4 - 8 PM EST | 4 - 8 PM EST | 4 - 8 PM EST | 4 - 8 PM EST | 4 - 8 PM EST | 4 - 8 PM EST | 4 - 8 PM EST | | ||
| **Hector Colmenares** | 4 - 7 PM EST | 4 - 5.5 PM EST| 4 - 7 PM EST | 4 - 5.5 PM EST| 4 - 7 PM EST | 12 - 4 PM EST | Not available | | ||
| **Semira Tesfai** | 5 - 8 PM EST | 5 - 8 PM EST | 5 - 8 PM EST | 5 - 8 PM EST | 5 - 8 PM EST | 6 - 8 PM EST | 5 - 8 PM EST | | ||
| **Chrismy Augustin** | 5 - 9 PM EST | 5 - 9 PM EST | 5 - 9 PM EST | 5 - 9 PM EST | 5 - 9 PM EST | 5 - 9 PM EST | 5 - 9 PM EST | | ||
| **Ana Isabel Murillo** | 7 - 10 PM EST| 7 - 10 PM EST | 7 - 10 PM EST | 7 - 10 PM EST | 7 - 10 PM EST | 12 - 4 PM EST | Not available | | ||
| **Pierre Kenley MERVIL** | 7 AM - 10 PM | 5 - 10 PM EST | 7 AM - 10 PM | 5 - 10 PM EST | 5 - 10 PM EST | 7 AM - 10 PM | 5 - 10 PM EST | | ||
| **Cliforde Exael** | 5 - 9 PM EST | 5 - 9 PM EST | 5 - 9 PM EST | 5 - 9 PM EST | 5 - 9 PM EST | 5 - 9 PM EST | 5 - 9 PM EST | | ||
|
||
______________________________________________________________________ | ||
<!-- markdownlint-enable MD013 --> | ||
### How many hours everyone has per day | ||
|
||
- **Ramon Colmenares**: 4 hours | ||
- **Hector Colmenares**: 3.5 hours | ||
- **Ana Isabel Murillo**: 3 hours | ||
- **Chrismy Augustin**: 4 hours | ||
- **Pierre Kenley MERVIL**: 5 hours | ||
- **Cliforde Exael**: 4 hours | ||
- **Semira Tesfai**: 3 hours | ||
|
||
## 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 | ||
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 |
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 |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Constraints | ||
|
||
Some boundaries around our project. | ||
|
||
## External | ||
|
||
- **Project Deadlines**: The project must be completed and delivered by | ||
**January 8th**. Extensions are not an option. | ||
- **Technology Requirements**: We are required to use specific technologies such | ||
as VS Code, Python, and GitHub. | ||
- **Testing Standards**: All code must pass a minimum of 90% unit test coverage | ||
and meet quality metrics defined by MIT Emerging Talent Foundations Track instructors. | ||
- **Connectivity**: Some team members might face intermittent internet connectivity. | ||
|
||
## Internal: Involuntary | ||
|
||
- **Skill Levels**: The team includes members with varying levels of expertise, | ||
with some being beginners who are still learning the required tools and technologies. | ||
- **Time Availability**: Team members have varying schedules and commitments, | ||
which can impact how much time each person can contribute. | ||
- **Learning Curve**: Beginners may require additional time to learn new tools, | ||
frameworks, or workflows, potentially slowing progress. | ||
|
||
## Internal: Voluntary | ||
|
||
- **Independent Work**: Each team member works independently on their assigned | ||
tasks but can seek advice or guidance from others as needed. | ||
- **Coding Standards**: The team has agreed to follow a consistent coding style | ||
guide to maintain quality and readability. | ||
- **Code Reviews**: All pull requests will be reviewed by at least two other | ||
team members to ensure quality and foster knowledge sharing. | ||
- **Collaboration Tools**: Communication tools like Slack will be used for quick | ||
questions and advice, while GitHub Discussions and Issues will handle more | ||
structured feedback. | ||
- **Documentation**: Clear and beginner-friendly comments and documentation are | ||
mandatory for all code to make it accessible to everyone on the team. | ||
- **Scope Management**: To ensure progress, the project scope is limited to core | ||
features. | ||
- **Flexibility**: Pioneers United encourages flexibility, allowing members to | ||
ask for help or advice at any point without hesitation. |
Oops, something went wrong.