From: Karthik Nayak <karthik.188@gmail.com>
To: Aishwarya Narayanan <aishnana.03@gmail.com>, git@vger.kernel.org
Subject: Re: GSoC 2024
Date: Mon, 25 Mar 2024 10:45:38 -0700 [thread overview]
Message-ID: <CAOLa=ZRqkKhqUPjrYQWmLnLAf6Cmt17ZSMJja0rYLNWifUG+og@mail.gmail.com> (raw)
In-Reply-To: <CAHCXyj3U69qyhYewOLY9hN2rvi_5ZuSxQEBJbDxrKefm9MzVWg@mail.gmail.com>
[-- Attachment #1: Type: text/plain, Size: 3151 bytes --]
Aishwarya Narayanan <aishnana.03@gmail.com> writes:
Hello,
> 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.
> 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.
> 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.
> 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
> 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/
>
> Thank you very much for your time and assistance. I look forward to
> your guidance.
>
> Best regards,
> Aishwarya Narayanan
Wish you luck!
- Karthik
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 690 bytes --]
next prev parent reply other threads:[~2024-03-25 18:17 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-22 6:57 GSoC 2024 Aishwarya Narayanan
2024-03-25 17:45 ` Karthik Nayak [this message]
2024-03-26 9:03 ` Aishwarya Narayanan
2024-03-26 11:22 ` Patrick Steinhardt
-- strict thread matches above, loose matches on Subject: below --
2024-03-04 6:01 Aishwarya Narayanan
2024-03-04 8:37 ` Christian Couder
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAOLa=ZRqkKhqUPjrYQWmLnLAf6Cmt17ZSMJja0rYLNWifUG+og@mail.gmail.com' \
--to=karthik.188@gmail.com \
--cc=aishnana.03@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).