GSoC 2024

GSoC 2024

[Aishwarya Narayanan]

Dear Git Organization,

I am writing to express my strong interest in participating in Google
Summer of Code (GSoC) 2024 with the Git Organization. As a highly
motivated Final-year Electrical and Electronics Engineer, I am eager
to contribute to the open-source community and learn from experienced
developers like yourselves.

While this is my first foray into open-source development and GSoC, I
am excited by the prospect of contributing to the ongoing success of
Git. I have been actively learning and gaining a strong foundation in
Git commands, programming languages, and version control concepts. I
am particularly interested in the following project ideas:
1) Implement consistency checks for refs
2) Move existing tests to a unit testing framework

However, I understand the importance of starting with smaller
contributions before taking on a larger project like GSoC. I am eager
to begin by contributing to micro-projects and familiarizing myself
with the Git codebase and development workflow.

In this regard, I would greatly appreciate any guidance you can offer
on where to find existing micro-projects and how to get involved in
the Git community. Additionally, I would be grateful for any resources
or suggestions that can help me prepare for GSoC and submit a strong
proposal.

Thank you for your time and consideration. I am enthusiastic about the
opportunity to contribute to the Git project and look forward to
hearing from you soon.

Sincerely,
Aishwarya N
aishnana.03@gmail.com
https://github.com/Aishwarya-Narayanan03

Re: GSoC 2024

[Christian Couder]

Hi,

On Mon, Mar 4, 2024 at 7:02 AM Aishwarya Narayanan
<aishnana.03@gmail.com> wrote:
>
> Dear Git Organization,
>
> I am writing to express my strong interest in participating in Google
> Summer of Code (GSoC) 2024 with the Git Organization. As a highly
> motivated Final-year Electrical and Electronics Engineer, I am eager
> to contribute to the open-source community and learn from experienced
> developers like yourselves.

Thanks for your interest in contributing to Git!

> While this is my first foray into open-source development and GSoC, I
> am excited by the prospect of contributing to the ongoing success of
> Git. I have been actively learning and gaining a strong foundation in
> Git commands, programming languages, and version control concepts. I
> am particularly interested in the following project ideas:
> 1) Implement consistency checks for refs
> 2) Move existing tests to a unit testing framework
>
> However, I understand the importance of starting with smaller
> contributions before taking on a larger project like GSoC. I am eager
> to begin by contributing to micro-projects and familiarizing myself
> with the Git codebase and development workflow.
>
> In this regard, I would greatly appreciate any guidance you can offer
> on where to find existing micro-projects and how to get involved in
> the Git community. Additionally, I would be grateful for any resources
> or suggestions that can help me prepare for GSoC and submit a strong
> proposal.

Please take a look at the following web pages:

  - https://git.github.io/General-Microproject-Information/
  - https://git.github.io/SoC-2024-Microprojects/

Thanks!

GSoC 2024

[Aishwarya Narayanan]

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.

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.

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.

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.

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.

Thank you very much for your time and assistance. I look forward to
your guidance.

Best regards,
Aishwarya Narayanan

Re: GSoC 2024

[Karthik Nayak]

[-- 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 --]

Re: GSoC 2024

[Aishwarya Narayanan]

Dear Git Project Maintainers,

Assistance Needed: Locating Test Script for Addressing Git's Exit Code
Suppression. I hope this email finds you well. My name is Aishwarya,
and I am reaching out to seek assistance with a microproject I am
working on within the Git project.

As part of my efforts to contribute to the Git project, I am currently
focusing on addressing the suppression of Git's exit code in test
scripts, as outlined in the project's microproject ideas.
Specifically, I aim to identify a test script within the t directory
where Git's exit code may be inadvertently suppressed.

While I have attempted to locate such a test script independently, I
have encountered challenges in identifying a suitable candidate.
Therefore, I am reaching out to request guidance from the project
maintainers in locating a test script where this issue needs to be
addressed.
I tried commands that included:
grep -Er "git .* \|" t/, grep -R "git .* |" t/, findstr /s /i /p "git .* |" *.sh

Could you please provide any insights or guidance on identifying a
test script within the t directory that exhibits the suppression of
Git's exit code? Any pointers or suggestions would be greatly
appreciated.

Additionally, if there are specific criteria or patterns that I should
look for when identifying such test scripts, please let me know, and I
will ensure to align my search accordingly.

Thank you very much for your time and assistance. I am eager to
contribute to the Git project and look forward to your guidance in
this matter.


Best regards,
Aishwarya Narayanan


On Mon, 25 Mar 2024 at 23:15, Karthik Nayak <karthik.188@gmail.com> wrote:
>
> 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

Re: GSoC 2024

[Patrick Steinhardt]

[-- Attachment #1: Type: text/plain, Size: 2132 bytes --]

On Tue, Mar 26, 2024 at 02:33:59PM +0530, Aishwarya Narayanan wrote:
> Dear Git Project Maintainers,
> 
> Assistance Needed: Locating Test Script for Addressing Git's Exit Code
> Suppression. I hope this email finds you well. My name is Aishwarya,
> and I am reaching out to seek assistance with a microproject I am
> working on within the Git project.

Please not that top-posting is discouraged on the Git mailing list [1].

> As part of my efforts to contribute to the Git project, I am currently
> focusing on addressing the suppression of Git's exit code in test
> scripts, as outlined in the project's microproject ideas.
> Specifically, I aim to identify a test script within the t directory
> where Git's exit code may be inadvertently suppressed.
> 
> While I have attempted to locate such a test script independently, I
> have encountered challenges in identifying a suitable candidate.
> Therefore, I am reaching out to request guidance from the project
> maintainers in locating a test script where this issue needs to be
> addressed.
> I tried commands that included:
> grep -Er "git .* \|" t/, grep -R "git .* |" t/, findstr /s /i /p "git .* |" *.sh
> 
> Could you please provide any insights or guidance on identifying a
> test script within the t directory that exhibits the suppression of
> Git's exit code? Any pointers or suggestions would be greatly
> appreciated.
> 
> Additionally, if there are specific criteria or patterns that I should
> look for when identifying such test scripts, please let me know, and I
> will ensure to align my search accordingly.

The command proposed by Karthik (which is also part of your pipeline
above) does result in several matches in "t/", some of which are actual
good candidates for a micro project. Did you scan through these matches?
The microprojects page at [2] should give you a good idea for what to be
on the lookout for as it explains the issue as well as highlighting some
patterns to watch out for.

Patrick

[1]: https://www.mediawiki.org/wiki/Mailing_list_etiquette
[2]: https://git.github.io/SoC-2024-Microprojects/

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]