[rfc-i] GitHub references

Paul Hoffman paul.hoffman at vpnc.org
Tue Mar 27 05:57:17 PDT 2018


On 27 Mar 2018, at 5:46, Heather Flanagan (RFC Series Editor) wrote:

> Thank you, all, for your feedback. I strongly agree that we should be
> targeting a reference format that applies to source code repositories 
> in
> general, acknowledging that GitHub is currently the leading favorite 
> for
> most. After further discussion within the RFC Editor, we're proposing
> the following structure:
>
>
> Proposed Guidance on referencing web-based public code repositories
> (e.g., Github)
>
> 1) Should not appear as Normative References.
>
> 2) Format of reference entries:
>
> authors — omit them
>
> title — include if available (some judgement may be required on the 
> part
> of the editors and authors to have a sensible title)
>
> commit hash — include if exists, short form preferred if available
>
> date — use date of last commit at time doc is edited
>
> URL — include URL to main page of repository

This makes sense. However, I'm unclear in the current tooling how to 
include the commit hash. It's not part of the title, nor is it an 
author.

--Paul Hoffman


More information about the rfc-interest mailing list