Skip to content

Some tweaks to the Microproject information #764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 31, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 35 additions & 16 deletions General-Microproject-Information.md
Original file line number Diff line number Diff line change
@@ -39,11 +39,10 @@ well using the Git development process.

It is *expected* that what you send will need several rounds of
reviews and discussions. If you are not sure at all about a patch you
can put "[GSoC RFC/PATCH]" or "[Outreachy RFC/PATCH]", depending on
the mentoring program you are applying for, at the beginning of its
subject.
can mark it as RFC in the subject. See [section below](#use-a-tag-like-gsoc-outreachy-etc-in-your-subject)
about how to mark patches as RFC.

Consider [a sample email thread](http://public-inbox.org/git/1386590745-4412-1-git-send-email-t.gummerer@gmail.com/T/#u),
Consider [a sample email thread](https://public-inbox.org/git/1386590745-4412-1-git-send-email-t.gummerer@gmail.com/T/#u),
which shows how a developer proposed a change and a patch to implement
it. The problem being solved, the design of the proposed solution,
and the implementation of that design were all reviewed and discussed,
@@ -62,7 +61,7 @@ To complete a microproject, you will have to go through approximately
the following steps:

* Download the source code: clone the repository using the
[Git via Git](http://git-scm.com/downloads) instructions and read
[Git via Git](https://git-scm.com/downloads) instructions and read
the `README` file.

* Build the source code: this is described in the file `INSTALL`.
@@ -75,7 +74,7 @@ the following steps:
described in `Documentation/SubmittingPatches`. A more detailed
step-by-step guide could be found in [`Documentation/MyFirstContribution.txt`](https://git-scm.com/docs/MyFirstContribution).

* The "[Hacking Git](https://git.github.io/Hacking-Git/)" page
* The "[Hacking Git](/Hacking-Git/)" page
could also serve as a handy resource. It points to resources
on various topics related to working on Git.

@@ -98,15 +97,17 @@ the following steps:

* Commit your change. Surprise: we use Git for that, so you will need
to gain at least
[a basic familiarity](http://git-scm.com/documentation) with using
[a basic familiarity](https://git-scm.com/docs) with using
Git. Make sure to write a good commit message that explains the
reason for the change and any ramifications. You can find information
on writing a good commit message in the
["Describe your changes well" section of the `SubmittingPatches` document](https://git-scm.com/docs/SubmittingPatches#describe-changes).
Remember to make sure
that you agree with our "Developer's Certificate of Origin" (whose
text is contained in `Documentation/SubmittingPatches`), and to
signify your agreement by adding a `Signed-off-by` line.
signify your agreement by adding a `Signed-off-by` line. Instructions
on how to add the sign-off is covered in the `SubmittingPatches`
document.

* *Optional, but recommended:*
With an account at GitHub, you can use GitHub CI to test your changes
@@ -125,8 +126,8 @@ the following steps:

If a branch did not pass all test cases then it is marked with a red cross. In
that case you can click on the failing job and navigate to
"ci/run-build-and-tests.sh" and/or \
"ci/print-test-failures.sh". You can also
`ci/run-build-and-tests.sh` and/or \
`ci/print-test-failures.sh`. You can also
download "Artifacts" which are tarred (or zipped) archives with test data
relevant for debugging. Fix the problem and push your fix to your GitHub fork.
This will trigger a new CI build. Ensure all tests pass.
@@ -186,7 +187,7 @@ of them.

In general it's a good idea to check on the mailing list archive
([lore.kernel.org](https://lore.kernel.org/git/) and
[Public Inbox](http://public-inbox.org/git/) are your friends) what
[Public Inbox](https://public-inbox.org/git/) are your friends) what
other GSoC or Outreachy applicants attempting a microproject have
already been told this year or any previous year, as hopefully it will
help you avoid some mistakes. As some microproject ideas haven't
@@ -372,11 +373,8 @@ tell us about your skills, interests, experience, background,
etc. Feel free to tell us what you want about yourself if you wish
though.

### Specify the mentoring program in the subject

But please, make it clear that you are interested in a specific
mentoring program and use the right tag, like "[GSoC]", "[Outreachy]",
etc at the beginning of the subject of your emails.
Make sure to specify your mentoring program clearly as
[suggested below](#use-a-tag-like-gsoc-outreachy-etc-in-your-subject).

### Thoroughly check your eligibility in the program

@@ -483,6 +481,27 @@ other applicants or contributors participating in GSoC or Outreachy
have been doing in the past, for example what kind of microproject
they have chosen, how their proposal looked like, etc.

If you're using `format-patch` for sending your patches to the mailing list,
you can add this tag as follows:

```
git format-patch --subject-prefix='GSoC PATCH' <other-arguments>

(or)

git format-patch --subject-prefix='Outreachy PATCH' <other-arguments>
```

If you want to mark your patch as RFC, use

```
git format-patch --rfc --subject-prefix='GSoC PATCH' <other-arguments>

(or)

git format-patch --rfc --subject-prefix='Outreachy PATCH' <other-arguments>
```

### Reply inline

Many people these days use the "top posting" posting style, but we