{"thread":{"id":"57254","subject":"Fwd: [gitgitgadget/git] README.md: add CodingGuidelines and a link for Translators (PR #1115)","startedAt":"2022-01-15T18:29:23Z","lastAt":"2022-01-15T18:29:23Z","messageCount":1,"participants":["Philip Oakley"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"446296","messageId":"c9cd9e57-c9d0-63a4-d533-cbd141cf095b@iee.email","threadId":"57254","inReplyTo":"55336cbf-9915-27fc-82ca-8e85c8320199@iee.email","subject":"Fwd: [gitgitgadget/git] README.md: add CodingGuidelines and a link for Translators (PR #1115)","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.email","sentAt":"2022-01-15T18:29:17Z","receivedAt":"2022-01-15T18:29:23Z","isPatch":false,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"@Dscho pointed out I should reply to the list not GGG. Hope this works\n\n-------- Forwarded Message --------\nSubject: \tRe: [gitgitgadget/git] README.md: add CodingGuidelines and a\nlink for Translators (PR #1115)\nDate: \tSat, 15 Jan 2022 10:45:43 +0000\nFrom: \tPhilip Oakley \nTo: \tgitgitgadget/git\n,\ngitgitgadget[bot] , gitgitgadget/git\n\nCC: \tMention \n\n\n\nOn 15/01/2022 00:50, gitgitgadget[bot] wrote:\n> On the Git mailing list\n> , Junio C\n> Hamano wrote (reply to this\n> ):\n>\n> Philip Oakley writes: > Unfortunately it `[]`\n> is not working for me for the new additions. > GitHub magic? Let's\n> step back a bit. Is there somebody reading README.md as a more generic\n> MarkDown? I do not think our build procedure creates any rendered\n> document from it.\nGitHub will auto render the README.md at the bottom of the git.git home\npage, and will render any .md files when they are visited. I just\nchecked GitLab which looks to do the same rendering.\n\nI prepared the changes because of a user question on the \"Git for Human\nBeings\" git-users list\nhttps://groups.google.com/d/msgid/git-users/aa68b9c8-4cf4-4193-8af3-79d7e3feafbbn%40googlegroups.com\nabout some linter issues with C99 and an offer to help.\n\nDespite having answered such questions before it still took a while to\nfind the right pointers for the user, hence the proposed clarifications.\n\n> My recollection was that we moved from README.txt to README.md for the\n> sole purpose of showing it https://github.com/git/git/ as more than\n> just a plain text, so it is a hard requirement that GitHub flavored\n> MarkDown renderer is happy with whatever we write in the file. If\n> GitHub flavored MarkDown only supports [] and breaks with (), then\n> there is no need for further discussion. We must stick to [] that has\n> been working for us in the file. On the other hand, if both () and []\n> work well at GitHub, I am OK to replace [] to (), so that it shows\n> well at GitHub and also it can be used with other MarkDown renderers.\n\nOddly it appears that the [] was only working for the original text, but\nthat () was needed for my new text. I'm not able to explain why, but\ndidn't want too much churn within the patch.\n\n> I prefer, from the organizational point of view, to see two patches,\n> in this order, if we were to go that way. [PATCH 1/2] README: link to\n> more contributor documents which uses [] (not ()). After this,\n> README.md uses only [], including the two links you add in this step.\n> And then [PATCH 2/2] README: use \"()\", not \"[]\", to please more\n> MarkDown processors which replaces all uses of [] with (). That would\n> allow us to queue both, try them out, and we can back out [2/2] if\n> GitHub's renderer does not like the result.\nAlready been there. GitHub would only render the old text as links when\nI pushed to my repo and viewed the README.md in my browser, so 2/2 would\nneed to go first, but without any obvious need...\n\nI was hoping someone might know why? It feels very screwy to me.\n---\n\nfollow up\nI'll redo the series as\n1/2 : use \"()\", not \"[]\", to please Markdown processors\n2/2 : README: link to more contributor documents\n"}]}