forked from MIT-Emerging-Talent/ET6-practice-code-review
-
Notifications
You must be signed in to change notification settings - Fork 0
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 #8 from MIT-Emerging-Talent/constraints
add constraints
- Loading branch information
Showing
2 changed files
with
74 additions
and
27 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,78 @@ | ||
<!-- this template is for inspiration, feel free to change it however you like! --> | ||
# **Constraints** | ||
|
||
# Constraints | ||
Every project operates within a unique set of boundaries that define what is possible, | ||
practical, and achievable. These constraints help shape the project’s scope, set | ||
expectations, and guide decision-making throughout its lifecycle. By understanding | ||
and defining these limitations early, we can establish a clear framework for what | ||
the project can and cannot include. | ||
|
||
Some boundaries around our project. | ||
Constraints are not just obstacles; they can also be tools for innovation. When | ||
used constructively, they push us to think critically and find creative solutions | ||
within the defined boundaries. This document outlines both **external factors** | ||
(which we cannot control) and **internal constraints** (both involuntary and voluntary) | ||
that influence our approach. Together, these considerations will help us craft a | ||
realistic and impactful project that meets its objectives efficiently and effectively. | ||
|
||
## External | ||
## **External Constraints** 🚧 | ||
|
||
<!-- | ||
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 | ||
- ... | ||
--> | ||
External constraints are limitations imposed by factors outside the team’s direct | ||
control. These constraints shape the scope, timeline, and feasibility of the project, | ||
requiring careful planning and adaptability. Key external constraints include: | ||
|
||
## Internal: Involuntary | ||
- **Internet Connectivity** 🌐: Unreliable or slow internet access can disrupt | ||
- communication, research, and collaborative workflows, affecting project progress. | ||
- **Power Outages** ⚡: Unpredictable power cuts can interrupt work, delay progress, | ||
- and impact productivity, especially in locations without backup power. | ||
- **Competing Workload** 📚: Team members juggling other responsibilities, such | ||
as additional jobs or unrelated projects, can reduce the time and focus dedicated | ||
to the current project. | ||
- **Resource Availability** 🔧: Limited access to external tools, materials, or | ||
technologies required for the project can create bottlenecks. | ||
|
||
<!-- | ||
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 | ||
--> | ||
## **Internal Constraints: Involuntary** 🔒 | ||
|
||
## Internal: Voluntary | ||
Internal involuntary constraints arise from unavoidable limitations within the team | ||
or organization. These constraints are inherent and require careful management to | ||
ensure they do not hinder project success. Key involuntary constraints include: | ||
|
||
<!-- | ||
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 | ||
--> | ||
- **Time Availability** ⏳: Team members may have limited hours to dedicate to the | ||
project due to fixed schedules, personal commitments, or overlapping responsibilities. | ||
- **Varied Skill Sets** 🛠️: Differences in expertise or gaps in knowledge within | ||
the team can create dependencies, requiring additional training or external support | ||
to complete certain tasks. | ||
- **Other Priorities** 🔄: Internal competing priorities, such as involvement in | ||
other projects, deadlines, or other responsibilities, can reduce the focus and | ||
effort allocated to this project. | ||
|
||
Recognizing these constraints helps the team set realistic goals, plan effectively, | ||
and address challenges proactively to maintain productivity. | ||
|
||
## **Internal Constraints: Voluntary** 💡 | ||
|
||
Voluntary internal constraints are self-imposed limitations set by the team to guide | ||
the project and ensure quality, efficiency, and alignment with goals. These constraints | ||
reflect deliberate decisions made to improve outcomes and maintain focus. Key voluntary | ||
constraints include: | ||
|
||
- **Time Management Rules** 🕒: Allocating specific working hours or limiting overtime | ||
to maintain work-life balance and prevent burnout. | ||
- **Skill Development Focus** 📈: Prioritizing tasks that align with team members’ | ||
learning goals or strengths to foster growth while ensuring quality output. | ||
- **Project Scope Definition** 🎯: Deliberately narrowing the scope to focus on essential | ||
features and deliverables, avoiding unnecessary complexity or scope creep. | ||
- **Adherence to Standards** 📑: Committing to practices like clean coding, thorough | ||
documentation, and consistent testing, as well as going through the code review checklist | ||
to ensure quality and consistency throughout the project. | ||
|
||
These constraints are designed to create a structured and sustainable workflow, enabling | ||
the team to deliver a high-quality project while fostering creativity and collaboration. | ||
|
||
## **Call to Action** 🚀 | ||
|
||
We encourage everyone to continuously evaluate the constraints that affect their | ||
work and communicate any challenges or solutions as they arise. If you encounter | ||
any | ||
constraints that impact your ability to deliver, collaborate with the team to develop | ||
a plan and overcome them and free to create an issue. Together, we can navigate | ||
these challenges and ensure | ||
the success of the project! |
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