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 #10 from MIT-Emerging-Talent/5-constraints
constraints.md merging to main
- Loading branch information
Showing
2 changed files
with
62 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
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,66 @@ | ||
<!-- this template is for inspiration, feel free to change it however you like! --> | ||
# ⚙️ Project Boundaries & Constraints | ||
|
||
# Constraints | ||
## 🚧 Clear Boundaries for Efficiency | ||
|
||
Some boundaries around our project. | ||
To ensure efficiency and balanced contributions,the project should have | ||
clear boundaries. | ||
|
||
## External | ||
Roles and responsibilities should be well-defined to prevent | ||
overlapping efforts. | ||
|
||
<!-- | ||
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 | ||
- ... | ||
--> | ||
Expectations should be set for balanced contributions, considering | ||
members' constraints. | ||
|
||
## Internal: Involuntary | ||
A culture of constructive feedback and solution-focused discussions | ||
should be established. | ||
|
||
<!-- | ||
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 | ||
--> | ||
A clear process for resolving conflicts is essential. | ||
|
||
## Internal: Voluntary | ||
These boundaries aim to create a productive and supportive | ||
environment for the team | ||
|
||
<!-- | ||
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 | ||
--> | ||
## 🌍 External Constraints | ||
|
||
The team faces several external constraints impacting collaboration: | ||
|
||
* **🌍 Timezones:** Remote work across different timezones can | ||
be challenging. | ||
* **🌐 Internet Access:** Limited or unstable internet access complicates | ||
communication and online collaboration. | ||
* **👨👩👧👦 Family & Work:** Some members are constrained by family and work | ||
responsibilities. | ||
* **📚 Academic Commitments:** Others face time limitations due to | ||
university exams. | ||
|
||
## ⚙️ Internal Involuntary Constraints | ||
|
||
'''The team faces several **internal involuntary constraints** that affect | ||
their progress:''' | ||
|
||
* **📂 Git & GitHub Knowledge:** Many members lack prior knowledge or | ||
experience with Git and GitHub. | ||
* **🛠️ Technical Expertise:** Limited technical expertise, combined with | ||
new skills | ||
required, is a challenge to the team members. | ||
* **⏳ Time Availability:** Balancing professional commitments and personal | ||
responsibilities limits availability. | ||
|
||
These factors create hurdles in both **skill development** and | ||
**team collaboration**. | ||
|
||
## 🛠️ Internal Voluntary Constraints | ||
|
||
Members commit to the following **voluntary constraints** to ensure | ||
steady progress: | ||
|
||
* **📝 Daily Progress Updates:** Members will provide daily updates on | ||
their progress. | ||
* **💻 Medium-level Coding Challenges:** Focus on coding challenges that | ||
match everyone's skill level to promote learning. | ||
* **⚖️ Balancing Commitments:** Prioritizing a balance between project | ||
work and other commitments. | ||
* **📬 Asynchronous Communication:** Emphasis on using asynchronous methods | ||
like GitHub issues and pull requests. | ||
|
||
These guidelines aim to foster effective teamwork, skill development, and | ||
steady project progress. |