From 76b203d4629731c0ab17f56b2bee0f234c01bd7a Mon Sep 17 00:00:00 2001 From: Mojtaba Fayyaz <123536786+mojtabafayyaz@users.noreply.github.com> Date: Sat, 28 Dec 2024 16:17:15 +0500 Subject: [PATCH] Update constraints.md --- collaboration/constraints.md | 62 +++++++----------------------------- 1 file changed, 11 insertions(+), 51 deletions(-) diff --git a/collaboration/constraints.md b/collaboration/constraints.md index a8d29ce8..ece04917 100644 --- a/collaboration/constraints.md +++ b/collaboration/constraints.md @@ -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 - - **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 - - **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 - - -**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: @@ -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. -