firstcontributions/first-contributions

Fix angle bracket in HTML <pre> tag

Closed this issue · 1 comments

Sharl0tteIsTaken commented

🐞 Problem
In the English README file Push changes to GitHub section, in the first code block in the collapsible section (If you get any errors while pushing, click here:), the last line uses the character < within an HTML <pre> tag, causing <your-username> to be treated as an HTML tag and therefore invisible.

🎯 Goal
This effects all translated version of README that has this collapsible section. However, this issue isn't targeted to change all of it, I want to see your opinion on this, if this is an opportunity to make it possible for more people to solve issues as said here.

On a side note, this also introduces inconsistencies within the English README, since nowhere in it uses <> to emphasize part of text or git command, let me know your opinion on this too.

💡 Possible solutions
I'll ignore the inconsistencies part (the use of <>) for now, and solves this issue this by replacing < with &lt;.

Sharl0tteIsTaken commented

Also I would also like to take this opportunity to say that there are other problems I have found.
In the same section, the HTML <pre> tag has the incorrect format or indentation, causes part of error code to be outside of the <pre> tag.

For example the Armenian translation version of README:

<pre>remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.
remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information. fatal: Authentication failed for 'https://github.com//first-contributions.git/' Գնացեք GitHub-ի ձեռնարկ ձեր հաշվի համար SSH բանալի ստեղծելու և կազմաձևելու վերաբերյալ.

Note: This problem isn't limited to the Armenian translation only.