Skip to content

Commit

Permalink
Created a draft for the constraints for our group
Browse files Browse the repository at this point in the history
  • Loading branch information
likechrisss committed Dec 24, 2024
1 parent bf0026a commit 25c319c
Showing 1 changed file with 36 additions and 14 deletions.
50 changes: 36 additions & 14 deletions collaboration/guide/3_constraints.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,42 @@
# Constraints

After dreaming big, the most helpful thing you can can do to define your project
is to be clear about _what it isn't_. Thinking big is great for brainstorming
but can get in the way of finishing your projects on time.
Some boundaries around our project.

An important step to _scoping_ your project is to discuss your group's
**constraints** before you even begin thinking of user stories. Defining your
constraints will help to define a realistic project and commit to it.
Constraints can also help you to build a more creative project!
## External

It may not sound intuitive, but the fewer restrictions you have on your work the
less likely you are to find a creative solution! The crucial skills you need to
learn is how to place _constructive_ constraints on your project and on your
team.
- **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 the client.
- **Connectivity**: Some team members might face intermittent internet connectivity.

## `/collaboration/constraints.md`
## Internal: Involuntary

Fill out the template file in [/collaboration/constraints.md](../constraints.md)
as a group, either in a call or asynchronously.
- **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 impacts how much time each person can contribute.
- **Learning Curve**: Beginners may require additional time to learn new tools,
frameworks, or workflows, potentially slowing progress.
- **Time Zone Differences**: The team is distributed across multiple time zones,
which could make synchronous communication a bit challenging.

## Internal: Voluntary

- **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 member to ensure quality and foster knowledge sharing.
- **Collaboration Tools**: Communication tools like Slack 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**: The team encourages flexibility, allowing members to ask for
help or advice at any point without hesitation.

0 comments on commit 25c319c

Please sign in to comment.