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.
Docs: Added details to Constraints README with external, internal (vo…
…luntary and involuntary), and individual constraints.
- Loading branch information
Showing
1 changed file
with
87 additions
and
26 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,95 @@ | ||
| <!-- this template is for inspiration, feel free to change it however you like! --> | ||
| # Constraints README 📝 | ||
|
|
||
| # Constraints | ||
| ## Introduction 🌟 | ||
|
|
||
| Some boundaries around our project. | ||
| Welcome to the Constraints README! This document is here to help us understand | ||
| the challenges and limitations each team member faces while working on this project. | ||
| Since we're all learning and working remotely, there can be obstacles like different | ||
| time zones 🌍, schedules ⏰, weak internet 🌐, power outages ⚡, or simply being | ||
| new to GitHub 💻. | ||
|
|
||
| ## External | ||
| By outlining these constraints, we aim to make collaboration easier and ensure | ||
| everyone feels supported as we learn and grow together. Don’t worry, this is a | ||
| beginner-friendly space, and we’re all here to help each other improve! | ||
|
|
||
| <!-- | ||
| 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 | ||
| - ... | ||
| --> | ||
| ## Purpose 🎯 | ||
|
|
||
| ## Internal: Involuntary | ||
| The goal of this document is to identify and acknowledge the constraints we each | ||
| face while working on this project. By being transparent about our challenges, | ||
| we can plan better, support each other, and ensure smooth progress as a team. | ||
|
|
||
| <!-- | ||
| 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 | ||
| --> | ||
| ## Constraints ⚖️ | ||
|
|
||
| ## Internal: Voluntary | ||
| ### External Constraints 🌐 | ||
|
|
||
| <!-- | ||
| 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 | ||
| --> | ||
| These are factors that come from the outside and are beyond the team's control: | ||
|
|
||
| - **Project Deadlines:** ⏳ Deadlines set externally that affect how quickly we | ||
| need to deliver. | ||
| - **Number of Unit Tests:** 🧪 The number of unit tests required to pass a code review. | ||
| - **Schedules:** Academic, work, or personal commitments that limit availability. | ||
| - **Power or Connectivity Issues:** ⚡ Unpredictable external problems like power | ||
| outages or poor internet that could disrupt work. | ||
|
|
||
| --- | ||
|
|
||
| ### Internal: Involuntary Constraints 🚶♀️ | ||
|
|
||
| These are factors that come from within the team, and we have no control over them: | ||
|
|
||
| - **Individual Skill Levels:** 🧑💻 Varying levels of expertise among team members. | ||
| - **Task Preferences:** Specific tasks you enjoy or want to focus on to improve | ||
| your skills. | ||
| - **Time Availability:** ⏰ The amount of time available to work on the project | ||
| may vary from person to person. | ||
|
|
||
| --- | ||
|
|
||
| ### Internal: Voluntary Constraints 🙋♂️ | ||
|
|
||
| These are constraints that the team decides on to help scope and organize the | ||
| project. These can be voluntarily agreed upon to make the project manageable: | ||
|
|
||
| - **Coding Style & Conventions:** 🎨 Deciding on a standard coding style (e.g., | ||
| indentations, naming conventions). | ||
| - **Code Review Checklist:** ✅ Creating a checklist for code reviews to ensure consistency. | ||
| - **Hours to Spend Working:** 🕒 Deciding on a specific amount of time the team | ||
| wants to spend working per week. | ||
|
|
||
| --- | ||
|
|
||
| ## Tips for Managing Challenges 💡 | ||
|
|
||
| Here are some simple tips to help us overcome common constraints: | ||
|
|
||
| - **Time Zones:** 🕑 Use a shared tool like Google Calendar to plan meetings at | ||
| times that work for everyone. | ||
| - **Weak Internet:** 🌐 Keep changes small and commit frequently to avoid large uploads. | ||
| - **GitHub Beginners:** 🚀 Start with the GitHub Desktop app for an easier | ||
| introduction to Git. | ||
|
|
||
| --- | ||
|
|
||
| ## Individual Constraints 🧑🤝🧑 | ||
|
|
||
| Please add your own constraints below, using the template provided. This will | ||
| help everyone understand your challenges and plan accordingly. | ||
|
|
||
| ### Template | ||
|
|
||
| - **Skill Level:** 📊 [Beginner/Intermediate/Advanced in tools like GitHub or | ||
| VS Code] | ||
| - **Challenges:** 🌐 [Internet issues, limited resources, etc.] | ||
|
|
||
| --- | ||
|
|
||
| ### Example Entry (Just an example, could be anything) 🤔 | ||
|
|
||
| - **Skill Level:** Beginner with GitHub, might need help resolving conflicts 🆘 | ||
| - **Challenges:** Weak internet at night, may miss late-night pushes 🌙 | ||
|
|
||
| ## Final Note 📝 | ||
|
|
||
| Please don’t hesitate to share your constraints or ask for help if you’re stuck. | ||
| This is a learning experience for all of us, and we’re here to support each other! | ||
| The more open we are, the better we can work together. 🤝 |