[FFmpeg-devel] [PATCH] doc: add a few note for sponsorship candidates.

[Lou Logan]

On Thu, 19 Mar 2015 21:53:12 +0100, Nicolas George wrote:

> + at chapter So yeah, I would like to work on FFmpeg for @url{https://code.google.com/soc/, Google Summer of Code} / @url{http://sophia.estec.esa.int/socis/, ESA Summer of Code in Space} / @url{https://www.gnome.org/outreachy/, Outreachy} / [insert here the latest trendy program]. What must I do?

Dump the "So yeah,".

> +For the organization that sposors the program, there is probably a lot of
> +paperwork. But frankly, we do not care; if we liked paperwork, we would be
> +managers, not hackers.

s/sposors/sponsors

However, I don't think this paragraph is very helpful as it is.

Maybe something like this:

"Refer to the homepage of the sponsor organization for information about
eligibility, timeline, required paperwork, etc. This process is the
full responsibility of the intern; the limited available FFmpeg mentor
time is best spent on providing help specific to coding."

> +For us, there is not much to do: choose a proposed project that you want to
> +do, select a qualification task for that project that is not already taken
> +by someone else, announce you are about to start working, and then do so.

"As for FFmpeg: choose a proposed project that you want to do, select a
qualification task for that project that is not already taken by
someone else, announce your chosen qualification task on the
ffmpeg-devel mailing list, then start coding."

> +If at any point you have any question, do not hesitate to ask them.

"...on the ffmpeg-devel mailing list or #ffmpeg-devel IRC channel."

I'm aware you mention contact info below, but I think it's good to
drill this info.

> +Actually, yes, hesitate a few seconds, in case this question will make you
> +look dump. So read on.

I think this do not contribute anything helpful and can be removed.

> + at chapter How do I contact you? And, in fact, who are you?
> +
> +The people who work on FFmpeg do so mostly on their free time or as a
> +complement to their regular job in computing or consulting. To contact us,
> +you can use the devel mailing list or personal mail, depending on the
> +contents of the message. Use discretion. You can also try the IRC channel.

"To @url{https://ffmpeg.org/contact.html, contact us}, you can use the
ffmpeg-devel mailing list or the mentor's personal mail"

s/devel/ffmpeg-devel

> + at chapter How do I get to work?
> +
> +First, download FFmpeg. Not a prebuilt binary. Not a source snapshot. A full
> +Git clone tree. If you do not know what that means, then you have reading to
> +do.

"See @url{https://ffmpeg.org/git-howto.html, Using git to develop
FFmpeg} for more info."

> +You should subscribe to it, because otherwise, your mails will be held for
> +approval instead of arriving in a few seconds.

"approval for up to 48 hours"

Hopefully that may stop at least one user from sending one or more
messages to the queue, then subscribing, then re-sending again
resulting in dupes depending on how vigilant/lazy I am while clearing
the queue.

> +Also, be aware that some mail user agents send mails that are unreadable
> +except by themselves; some have strange ideas about paragraph formatting and
> +apply them to code snippet too. You can have a look at the low-tech mail
> +archive on the FFmpeg site to see how your mails actually look like.

"low-tech @url{https://lists.ffmpeg.org/pipermail/ffmpeg-devel/,
mailing list archive}"

> + at chapter What if, in the end, I am not taken?

s/taken/accepted

The rest of it looks good to me. Thanks for taking the time to do this.

Lou