Skip to content

Commit

Permalink
Update constraints.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mojtabafayyaz authored Dec 28, 2024
1 parent d81c819 commit 76b203d
Showing 1 changed file with 11 additions and 51 deletions.
62 changes: 11 additions & 51 deletions collaboration/constraints.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,45 @@
# Constraints

This section outlines the boundaries and considerations for our project
to ensure smooth collaboration, efficient learning, and effective task completion.
This section outlines the boundaries and considerations for our project to ensure smooth collaboration, efficient learning, and effective task completion.

## 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
- ...
-->

**These factors outside our control influence how we work on this project.**

- **Platform Requirements:**
- Problems must be selected from the workshop's exercises, CodeWars, LeetCode,
or similar coding platforms.

- Solutions must comply with the workshop's requirements (e.g., unit tests,
documentation, and clear variable names).
- Problems must be selected from the workshop's exercises, CodeWars, LeetCode, or similar coding platforms.
- Solutions must comply with the workshop's requirements (e.g., unit tests, documentation, and clear variable names).

- **Deadlines:**
- Projects must be completed according to the timeline set by the MIT Emerging
Talent program.
- Projects must be completed according to the timeline set by the MIT Emerging Talent program.
- Each member must solve and review problems within the agreed-upon timeframes.

- **Tools and Resources:**
- GitHub must be used for version control, communication, and documentation.
- The team must rely on publicly available resources (e.g., online tutorials and
documentation) to enhance learning.

- The team must rely on publicly available resources (e.g., online tutorials and documentation) to enhance learning.

## Internal Constraints: Involuntary

<!--
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
-->

**These are limitations or challenges within the team that we need to navigate effectively.**

- **Experience Levels:**
- Team members have varying levels of experience in programming, unit testing,
and documentation.
- Team members have varying levels of experience in programming, unit testing, and documentation.
- Some members may require more time or support to complete tasks.

- **Availability:**
- Team members may have different schedules and commitments, limiting
synchronous collaboration opportunities.
- Team members may have different schedules and commitments, limiting synchronous collaboration opportunities.

- **Technical Skills:**
- Limited familiarity with tools like Git, GitHub workflows, or unit testing
frameworks.
- Limited familiarity with tools like Git, GitHub workflows, or unit testing frameworks.

## Internal Constraints: Voluntary

<!--
Constraints that your team decided on to help scope the project.
They may include:
- coding style & conventions
- agreeing 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 self-imposed rules or boundaries designed to improve collaboration
and learning outcomes.**
**These are self-imposed rules or boundaries designed to improve collaboration and learning outcomes.**

- **Unit Testing:**
- All submitted solutions must include unit tests to verify correctness and edge
cases.
- All submitted solutions must include unit tests to verify correctness and edge cases.
- Use Python’s `unittest` module (or equivalent) for testing.


- **Documentation Standards:**
- All code must include meaningful comments explaining the logic.
- Problem solutions must include documentation with:
Expand All @@ -90,8 +53,5 @@ and learning outcomes.**
- Constructive feedback is required for all reviews.

- **Collaborative Learning:**
- Each member must share insights or challenges they faced during problem-solving
to help others learn.

- Each member must share insights or challenges they faced during problem-solving to help others learn.
- Regular check-ins (via GitHub comments or virtual meetings) to ensure alignment.

0 comments on commit 76b203d

Please sign in to comment.