Re: GSoC 2024

From: Karthik Nayak <karthik.188@gmail.com>
Date: Mar 25, 2024, 17:45 UTC
Message-ID: <CAOLa=ZRqkKhqUPjrYQWmLnLAf6Cmt17ZSMJja0rYLNWifUG+og@mail.gmail.com>
In-Reply-To: <CAHCXyj3U69qyhYewOLY9hN2rvi_5ZuSxQEBJbDxrKefm9MzVWg@mail.gmail.com>

Aishwarya Narayanan <aishnana.03@gmail.com> writes:

Hello,

Show 8 quoted lines

> Dear Git Organization,
>
> I hope this email finds you well. I am reaching out regarding a
> Request for Assistance with Microproject aimed at improving the
> integration test scripts in the Git project by avoiding the
> suppression of Git exit codes. As a beginner, I would greatly
> appreciate your guidance on how to approach this task effectively.
>

Thanks for your interest and reaching out.

Show 10 quoted lines

> Here's a breakdown of the microproject and how I plan to tackle it as
> a beginner:
>
> Understanding the Problem:
>
> The Git project utilizes Shell scripts for integration testing to
> ensure software stability.
> It's crucial to avoid suppressing the exit codes of Git commands in
> these scripts, as it may lead to errors going unnoticed.
>

Correct.

Show 8 quoted lines

> Identifying Problematic Patterns:
>
> I will examine the integration test scripts located in the t directory
> of the Git project.
> Specifically, I will search for instances where Git commands are piped
> into other commands, or where command substitution is used with Git
> commands.
>

The goal of the microproject is to help you get started with contributing to the Git codebase. As such, it is recommended that you focus on finding and fixing a single instance only.

Show 14 quoted lines

> Learning from Examples:
>
> I will refer to the provided examples of bad and good practices to
> understand what to look for and how to correct it.
> Understanding why certain practices are bad and others are good will
> help me grasp the underlying concepts better.
>
> Applying Correct Practices:
>
> When I identify instances of suppressed exit codes, I will modify the
> scripts to adhere to the good practices outlined.
> This may involve replacing problematic commands with alternatives that
> properly handle Git exit codes.
>

I would also recommend reading the following documents:
- Documentation/SubmittingPatches
- Documentation/MyFirstContribution.txt

Show 20 quoted lines

> Validation and Documentation:
>
> After making modifications, I will ensure that the scripts still
> function correctly by running the affected integration tests.
> I will document the changes made and provide explanations for why
> certain commands were modified. This documentation will aid in
> understanding the improvements made to the test suite.
>
> Seeking Feedback:
>
> Once the changes are implemented, I will seek feedback from mentors or
> collaborators to ensure that the modifications are in line with
> project standards.
>
> I would greatly appreciate any insights or advice you can offer to
> help me navigate through this microproject effectively. Additionally,
> if you could provide guidance on where to find another test script
> similar to the one referenced in commit c6f44e1da5, it would be
> immensely helpful.
>

Well, you could use a regex search to find some of them. This one is for finding tests with pipes used, but do note that you could get false positives here too:

    grep -Er "git .* \|" t/

Show 6 quoted lines

>
> Thank you very much for your time and assistance. I look forward to
> your guidance.
>
> Best regards,
> Aishwarya Narayanan

Wish you luck!

- Karthik