[v5,0/2] documentation: add lab for first contribution

Message

Emily Shaffer May 7, 2019, 9:30 p.m. UTC

Since v4, I've made one major change and a handful of minor changes. The
major change is contained entirely in patch 2/2; patch 1/2 has only nit
fixes compared to v4.

Major:
- I've added anchors to each section. These anchors are custom-named in
  order to be compatible with asciidoc as well as asciidoctor. I figured
  it would be easier to review the naming choices if the anchors stood
  alone from the main introductory patch.

Minor:
- Alphabetized Documentation/Makefile
- Fixup headers - a few renames for clarity, casing, and a missed
  monospace, based on Phil Hord & Jonathan Tan comments.
- Removed 'extern' from the addition to builtin.h
- Replace "cheating off" with "mimicking" in a few places
- Clarify instructions for writing commit message to remove ambiguity
  and include requirement for newline after subject
- Remove unnecessary explanation of `git commit --amend`
- Remove braces to bring code sample into Git style
- Typo, word-reversal, and early line break fixes
- Add neglected argument to `git send-email` samples to actually include
  patches

Emily Shaffer (2):
  documentation: add tutorial for first contribution
  documentation: add anchors to MyFirstContribution

 Documentation/Makefile                |    1 +
 Documentation/MyFirstContribution.txt | 1110 +++++++++++++++++++++++++
 2 files changed, 1111 insertions(+)
 create mode 100644 Documentation/MyFirstContribution.txt

Comments

Junio C Hamano May 8, 2019, 3:30 a.m. UTC | #1

Emily Shaffer <[e-mail]> writes:

> - Removed 'extern' from the addition to builtin.h

I said something that conflicts with this in my message to JTan, but
I am fine with this removal of extern, as it is reasonable that
Denton Liu's no-extern work would land soonish.

I agree with the spirit of all the other points listed in the cover
letter as well.  Thanks for working on this.