diff --git a/documents/QA/QA-meetings.md b/documents/QA/QA-meetings.md index f5126ab..9a2b76e 100644 --- a/documents/QA/QA-meetings.md +++ b/documents/QA/QA-meetings.md @@ -15,10 +15,6 @@ How to optimize code commenting for enhanced understanding? The team is expected to implement the optimized code commenting practices discussed, ensuring clarity and accessibility. Additionally, the utilization of the wiki for thorough code documentation, including individual pages for functions and specific documentation for complex functions, should be seamlessly integrated into the development workflow. This approach enhances code readability and supports ongoing collaboration within the team. - -#### Note: -/ - ---- # 2. QA Team 5-Minute Meeting @@ -59,10 +55,6 @@ The team is expected to implement the optimized code commenting practices discus - **GitHub Issue Guidance:** Introduction of guidance on GitHub issue creation and response. -#### Note: -/ - - ---- @@ -70,7 +62,7 @@ The team is expected to implement the optimized code commenting practices discus ## Meeting Date and Time: 2023-12-1 10:00 AM -## Objective: Team Coordination and d +## Objective: Team Coordination ### Content: - Developers struggle to work cohesively, leading to project issues, notable consequences include code duplication and project slowdown. @@ -84,5 +76,40 @@ The team is expected to implement the optimized code commenting practices discus -#### Note: -/ + +---- + +# 4. QA Team 5-Minute Meeting + +## Meeting Date and Time: 2023-12-7 10:00 AM + +## Objective: Code Sanitization + +### Content: +- **Branches to Delete:** + - Ghost-AI + - maze_to_back_buffer_ben + - movement-on-key-release + - collisions + +- **Branch "maze" Status:** + - Branch "maze" is significantly behind the current codebase. + +- **Code Sanitization:** + - Comments must provide meaningful insights beyond what is evident in the code. + - Variable names need to be clearer. + - Enforce naming conventions for casing and style. + - Group similar elements together, especially in the constants file. + - Remove debug code once its purpose is fulfilled. + +- **Pull Request Review Process:** + - Two reviewers for pull requests in both the main and dev branches. + - Reviewers include 1 QA and either the project manager or the tech leader. + +- **Code Merge:** + - Merge entry.asm and main.asm for streamlined code organization. + + +### After-Consequences: +The identified branches have been successfully deleted. The "maze" branch has been updated to align with the latest codebase. Code sanitization efforts are underway, emphasizing meaningful comments and improved variable naming. The team is committed to adhering to naming conventions and organizing code more systematically. The two-reviewer system for pull requests in the main and dev branches has been implemented, involving 1 QA and either the project manager or the tech leader. The merging of entry.asm and main.asm has contributed to a more cohesive codebase. These actions collectively aim to enhance code quality and collaboration within the development team. + diff --git a/documents/QA/Tests Report/2023-12-02-QuentinClement.md b/documents/QA/Tests Report/2023-12-02-QuentinClement.md new file mode 100644 index 0000000..fe6ab22 --- /dev/null +++ b/documents/QA/Tests Report/2023-12-02-QuentinClement.md @@ -0,0 +1,27 @@ +### Collaborative Report: + +**Date:** 2023-12-02 + +**Participants:** +- Quentin Clement +- Maxime Caron +- Thomas Planchard + + +1. **Code Availability:** + - Discussed the absence of new code for testing during the recent period. + - Acknowledged the temporary lack of code to assess. + +2. **Collaboration:** + - Emphasized the importance of regular code contributions to ensure continuous testing. + - Encouraged increased communication between development and QA teams to stay informed about upcoming code changes. + +3. **Upcoming Tasks:** + - Outlined the expectations for code availability in the next testing phase. + +**Next Steps:** +- Development Team: Commit to regular code updates and inform QA teams about upcoming changes. +- QA Team: Be prepared for increased testing activities once the new code is available. + +**Conclusion:** +The meeting concluded with a shared understanding of the current situation and a commitment to improving communication between development and QA teams. The absence of code for testing was acknowledged, and both teams are aligned on the importance of timely code contributions for efficient testing processes. \ No newline at end of file diff --git a/documents/QA/Tests Report/First-Report.md b/documents/QA/Tests Report/First-Report.md deleted file mode 100644 index e69de29..0000000 diff --git a/readme.md b/readme.md index a119035..a8df40e 100644 --- a/readme.md +++ b/readme.md @@ -4,23 +4,28 @@
Table of Contents + - [2023-2024 Project-2 x86-retrogaming Team-4](#2023-2024-project-2-x86-retrogaming-team-4) - [Pac-Man Clone](#pac-man-clone) - [Who are we?](#who-are-we) - [Overview](#overview) + - [Requirements](#requirements) + - [Installation](#installation) + - [Configuration](#configuration) +
## Who are we? -| Name | Role | Picture | 🔗 | -| ------------ | --------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------- | -| Léo CHARTIER | Project Manager | ![Léo's profile picture](https://avatars.githubusercontent.com/u/91249751?size=200) | [Léo's Github profile](https://github.com/leo-chartier) |t -| Antoine PREVOST | Program Manager | ![Antoine's profile picture](https://avatars.githubusercontent.com/u/81081224?size=200) | [Antoine's Github profile](https://github.com/leo-chartier) | -| Malo ARCHIMBAUD | Tech Lead | ![Malo's profile picture](https://avatars.githubusercontent.com/u/97161471?size=200) | [Malo's Github profile](https://github.com/Malo-Archimbaud) | -| Maxime THIZEAU | Junior Software Developer | ![Maxime's profile picture](https://avatars.githubusercontent.com/u/145995586?size=200) | [Maxime's Github profile](https://github.com/MaximeTAlgosup) | -| Benoît DE KEYN | Junior Software Developer | ![Benoît's profile picture](https://avatars.githubusercontent.com/u/146000855?size=200) | [Benoît's Github profile](https://github.com/benoitdekeyn-algosup) | -| Maxime CARON | Quality Assurance | ![Maxime's profile picture](https://avatars.githubusercontent.com/u/145995231?size=200) | [Maxime's Github profile](https://github.com/MaximeAlgosup) | -| Thomas PLANCHARD | Quality Assurance | ![Thomas's profile picture](https://avatars.githubusercontent.com/u/91249646?size=200) | [Thomas's Github profile](https://github.com/thomas-planchard) | +| Name | Role | Picture | 🔗 | +| ---------------- | ------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | +| Léo CHARTIER | Project Manager | ![Léo's profile picture](https://avatars.githubusercontent.com/u/91249751?size=200) | [Léo's Github profile](https://github.com/leo-chartier) | t | +| Antoine PREVOST | Program Manager | ![Antoine's profile picture](https://avatars.githubusercontent.com/u/81081224?size=200) | [Antoine's Github profile](https://github.com/leo-chartier) | +| Malo ARCHIMBAUD | Tech Lead | ![Malo's profile picture](https://avatars.githubusercontent.com/u/97161471?size=200) | [Malo's Github profile](https://github.com/Malo-Archimbaud) | +| Maxime THIZEAU | Junior Software Developer | ![Maxime's profile picture](https://avatars.githubusercontent.com/u/145995586?size=200) | [Maxime's Github profile](https://github.com/MaximeTAlgosup) | +| Benoît DE KEYN | Junior Software Developer | ![Benoît's profile picture](https://avatars.githubusercontent.com/u/146000855?size=200) | [Benoît's Github profile](https://github.com/benoitdekeyn-algosup) | +| Maxime CARON | Quality Assurance | ![Maxime's profile picture](https://avatars.githubusercontent.com/u/145995231?size=200) | [Maxime's Github profile](https://github.com/MaximeAlgosup) | +| Thomas PLANCHARD | Quality Assurance | ![Thomas's profile picture](https://avatars.githubusercontent.com/u/91249646?size=200) | [Thomas's Github profile](https://github.com/thomas-planchard) | ## Overview