Skip to content

Latest commit

 

History

History
68 lines (41 loc) · 4.09 KB

README.md

File metadata and controls

68 lines (41 loc) · 4.09 KB
Raw

🛠️ Code Review

Overview

In this engaging task, students will embark on performing a detailed code review of an existing application, focusing on the Movie App Code Review project. This exercise is crucial for enhancing your skills in understanding code quality, readability, and applying best practices in JavaScript development.

Objectives

  • Understand and Analyze Existing Code: Thoroughly dive into the codebase to grasp the structure, logic, and functionality of the application.
  • Identify Improvements: Actively look for areas where the code can be optimized or refactored to enhance performance, readability, and adherence to best practices.
  • Provide Constructive Feedback: Craft a comprehensive and insightful review, pinpointing both the strengths and areas that require improvement in the code.

Key Features

  1. Code Quality: Evaluate the code's readability, maintainability, and scalability, ensuring it meets high-quality standards.
  2. Best Practices: Scrutinize the application for adherence to coding best practices, including proper naming conventions, documentation, and a modular approach.

Technical Requirements

  • Familiarization: Deeply familiarize yourself with the project's repository on GitHub: Movie App Code Review.

Resources

  • Project Repository: Access the GitHub Repository for the Movie App project to start your review journey.

🗂️ Working with Repository Rules

Overview

These detailed guidelines are crafted for students undertaking the code review task. You are required to work within a private school repository, ensuring a structured and professional approach to manage your code review process.

Repository Management

  1. Branch Creation:
    • Start Fresh: Create a new branch named code-review from the main or master branch of your private school repository.
  2. Code Placement:
    • Organize: Place the code of the application to be reviewed in the code-review branch.
  3. Pull Request:
    • Initiate Review: Create a pull request from the code-review branch to the main or master branch. This will be your platform for conducting the code review.

Conducting the Code Review

  • In-Depth Analysis: Execute the code review directly within the pull request.
  • Comprehensive Coverage: Ensure your review is exhaustive, addressing all aspects as per the task evaluation criteria.
  • Engaging Feedback: Utilize GitHub's commenting features to add insightful review comments on specific code lines or sections as needed.

🚀 Task Submission to Cross-Check Rules

Completion and Submission

  • Finalize and Present: Once your code review is complete, prepare the pull request for mentor evaluation.
  • Submit with Confidence: Submit the pull request through the student dashboard in the RS App. Include the link to the pull request in the designated submission area.

Note on Submission

  • Your Gateway to Success: The link to your pull request serves as the official submission for this task.
  • Detail Oriented: Ensure that your pull request comprehensively contains all necessary information and comments related to your code review.
  • Accessibility is Key: The pull request doesn't require merging; it only needs to be accessible for mentor evaluation.

📋 Evaluation Criteria

✅ Mentor Evaluation Criteria (95 points - Total):

Refer to the detailed Mentor Evaluation Criteria to understand the scoring system.

📌 Professional Environment Simulation: This structured approach is crucial for maintaining organization and ensuring a smooth review process. It mimics a professional environment where pull requests are a standard method for code review and collaboration.

📌 Enhance Your Skills: This task is an excellent opportunity to practice critical analysis and constructive feedback skills, essential for collaborative coding environments.