[rfc-i] GitHub references

Heather Flanagan (RFC Series Editor) rse at rfc-editor.org
Tue Mar 27 06:05:33 PDT 2018


Hi Adam,

Are you thinking of something other than date of commit? Or are you
asking that we add hour/minute to that as well?

-Heather

On 3/27/18 5:58 AM, Adam Roach wrote:
> In the case that there is no hash, can we at least include a day (and
> preferably a time)?
>
> /a
>
> On Mar 27, 2018, at 07:46, Heather Flanagan (RFC Series Editor)
> <rse at rfc-editor.org <mailto:rse at rfc-editor.org>> 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
>>
>>
>> Examples:
>>
>> [pysaml2]  "Python implementation of SAML2", commit 7135d53
>> <https://github.com/IdentityPython/pysaml2/commit/7135d5370425b5a0fb18ddd604779f6195fc3306>,
>> March 2018. <https://github.com/IdentityPython/pysaml2>.
>>
>> [linuxlite] "Linux Lite", March 2018.
>> <https://sourceforge.net/projects/linuxlite/>
>> _______________________________________________
>> rfc-interest mailing list
>> rfc-interest at rfc-editor.org <mailto:rfc-interest at rfc-editor.org>
>> https://www.rfc-editor.org/mailman/listinfo/rfc-interest

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.rfc-editor.org/pipermail/rfc-interest/attachments/20180327/e4c74039/attachment.html>


More information about the rfc-interest mailing list