Skip to content

Commit

Permalink
fixed md formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Alemayehu-Desta committed Dec 26, 2024
1 parent be73bed commit 1de65dc
Showing 1 changed file with 49 additions and 23 deletions.
72 changes: 49 additions & 23 deletions collaboration/constraints.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,60 @@
<!-- this template is for inspiration, feel free to change it however you like! -->

# Constraints

Some boundaries around our project.
The group will operate under the following boundaries for the successful completion of the project.

## External

<!--
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
- ...
-->
- **Project Deadlines**:
The project must be completed within the agreed timeframe, with weekly milestones to track progress.

- **Technologies**:
The project will use predefined tools such as GitHub for collaboration and Python for coding.

- **Connectivity**:
Reliable internet access is required for meetings and code sharing, though some members may face connectivity issues.

- **Meeting Schedule**:
Meetings will be held at agreed times, but flexibility is limited by members' other responsibilities.

- **Compliance with CIL and Template**:
All documents and code submissions must pass the Continuous Integration and Linting (CIL) checks and adhere to the provided template to ensure consistency and quality.

## Internal: 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
-->
- **Skill Levels**:
Members have varying expertise in coding, testing, and using GitHub.

- **Time Availability**:
Members have different time commitments due to work, education, and family responsibilities.

- **Learning Curve**:
Some members may need additional time to learn new tools or techniques, which could affect timelines.

- **Personal Obligations**:
External responsibilities like exams or family events may temporarily limit availability.

## Internal: Voluntary

<!--
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
-->
- **Coding Style & Conventions**:
The group will follow an agreed-upon coding style guide for consistency.

- **Code Review Checklist**:
A standardized checklist will be used for peer reviews to ensure quality.

- **Function Assignment**:
Each member will prepare two functions, ensuring equal contribution.

- **Testing Requirements**:
Members will write and test their own functions and peer-review others' work.

- **Time Commitment**:
Members agree to dedicate at least 4–5 hours per week, with flexibility based on personal schedules.

- **Documentation**:
Each function must include clear and concise documentation.

- **Communication**:
Asynchronous communication will be used where possible to accommodate different schedules.

- **Task Prioritization**:
Critical tasks will take priority, and non-critical tasks will b

0 comments on commit 1de65dc

Please sign in to comment.