From 9f4155c5ddc2ce0751d11a222d1447c07208a7b2 Mon Sep 17 00:00:00 2001 From: Mojtaba Fayyaz <123536786+mojtabafayyaz@users.noreply.github.com> Date: Sat, 28 Dec 2024 10:39:26 +0500 Subject: [PATCH] Update constraints.md --- collaboration/constraints.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/collaboration/constraints.md b/collaboration/constraints.md index c3450d14..3b4cd49c 100644 --- a/collaboration/constraints.md +++ b/collaboration/constraints.md @@ -18,16 +18,20 @@ This section outlines the boundaries and considerations for our project to ensur **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 @@ -40,14 +44,17 @@ This section outlines the boundaries and considerations for our project to ensur **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 @@ -59,10 +66,12 @@ This section outlines the boundaries and considerations for our project to ensur - 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:** @@ -78,5 +87,6 @@ This section outlines the boundaries and considerations for our project to ensur - 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.