Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created a Draft for the group's constraints #10

Merged
merged 2 commits into from
Dec 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 28 additions & 22 deletions collaboration/constraints.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,40 @@
<!-- this template is for inspiration, feel free to change it however you like! -->

# Constraints

Some boundaries around our 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 and delivered by
**January 8th**. Extensions are not an option.
- **Technology Requirements**: We are required to use specific technologies such
as VS Code, Python, and GitHub.
- **Testing Standards**: All code must pass a minimum of 90% unit test coverage
and meet quality metrics defined by MIT Emerging Talent Foundations Track instructors.
- **Connectivity**: Some team members might face intermittent internet connectivity.

## 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**: The team includes members with varying levels of expertise,
with some being beginners who are still learning the required tools and technologies.
- **Time Availability**: Team members have varying schedules and commitments,
which can impact how much time each person can contribute.
- **Learning Curve**: Beginners may require additional time to learn new tools,
frameworks, or workflows, potentially slowing progress.

## 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
-->
- **Independent Work**: Each team member works independently on their assigned
tasks but can seek advice or guidance from others as needed.
- **Coding Standards**: The team has agreed to follow a consistent coding style
guide to maintain quality and readability.
- **Code Reviews**: All pull requests will be reviewed by at least two other
team members to ensure quality and foster knowledge sharing.
- **Collaboration Tools**: Communication tools like Slack will be used for quick
questions and advice, while GitHub Discussions and Issues will handle more
structured feedback.
- **Documentation**: Clear and beginner-friendly comments and documentation are
mandatory for all code to make it accessible to everyone on the team.
- **Scope Management**: To ensure progress, the project scope is limited to core
features.
- **Flexibility**: Pioneers United encourages flexibility, allowing members to
ask for help or advice at any point without hesitation.
Loading