Welcome to Matrix, the ultimate collaborative repository for
our code review work as part of the prestigious MIT Emerging Talent program!
In this digital universe, weβre diving into the world of programming
challenges, crafting solutions and learning the art of coding. π
This repository is dedicated to showcasing our team's approach to tackling a
variety of challenges, primarily focusing on Python implementations π,
but also exploring unittesting and version control systems (Git & GitHub).
Our work includes comprehensive testing π, ensuring quality and reliability,
as well as detailed documentation π, so that every piece of our work is
transparent, understandable, and replicable.
With every line of code we write, weβre building a new version of the
Matrix β one where logic and creativity seamlessly intertwine.
π» Choose the code. Follow the logic. Embrace the Matrix. ππ±
Stay tuned for future updates as we continue to evolve, learn, and grow in this digital journey. π
This repository is designed to help us grow as developers and collaborators. Hereβs what weβre aiming to achieve:
- βοΈ Enhance coding skills through practice and peer reviews.
- π οΈ Learn and implement best practices in software development.
- π€ Collaborate effectively using GitHub tools and workflows.
ET6-foundations-group-16/
βββ collaboration/ # Team collaboration documents
β βββ guide/ # Collaboration guidelines
β βββ constraints.md # Project constraints
β βββ communication.md # Team communication plan
β βββ learning_goals.md # Group & individual goals
β βββ retrospective.md # Reflection and retrospective summary
βββ notes/ # Shared learning notes
βββ solutions/ # Challenge solutions
β βββ tests/ # Unit tests
βββ .github/ # GitHub configuration
Ensure you have the following tools installed:
- π Python 3.8+
- π» Visual Studio Code
- π οΈ Git
Clone the repository:
git clone https://github.com/MIT-Emerging-Talent/ET6-foundations-group-16.git
cd ET6-foundations-group-16
Create a new branch for your solution:
git checkout -b feature/challenge-name
- Implement your solution in the solutions directory.
- Add tests in the tests directory.
- Submit a pull request for review.
- Address review feedback.
- Merge after approval.
For more details, refer to the CONTRIBUTING.md file.
We have detailed guidelines for collaboration in the
collaboration/guide
directory.
This includes:
- π A repository setup guide.
- π Group norms.
- π― Learning goals.
- π§ Project constraints.
- π A communication plan.
- π Project board setup.
- π οΈ Development workflow.
- π Retrospective process.
We will fill out the collaboration/retrospective.md file at the end of the project to document what went well and what didn't. This will help us improve continuously. π±
Check out the notes directory for shared learning materials. These include key concepts, tips, and thoughts we've shared along the way. π§ β¨
All challenge solutions are stored in the solutions directory. Each solution comes with:
- π Comprehensive documentation.
- β Thorough tests to ensure quality.
Make development easier with these tools:
- markdownlint: For linting and style checking Markdown files.
- pylint: A static code analysis tool for Python.
- ruffus: A Python computation pipeline library.
- Anas Ziadah β‘οΈ
- Fahed Daibes β‘οΈ
- Faisal Minawi β‘οΈ
- Majd ABOUALSOUD β‘οΈ
- Mohamed Altayeb β‘οΈ
- Obey Saleh β‘οΈ
- ΓzgΓΌr β‘οΈ
- Razan Ibrahim β‘οΈ
- Clement Mugisha β‘οΈ
This project is under active development as part of the MIT Emerging Talent Code Review exercises. Letβs make this an amazing learning journey together! π