fix(challenges): adding code tags to description

freeCodeCamp / curriculum

The freeCodeCamp curriculum and lesson editor

Creative Commons Attribution Share Alike 4.0 International

81 stars 124 forks source link

fix(challenges): adding code tags to description #306

Closed GlynL closed 5 years ago

GlynL commented 5 years ago

frames and other code in description were not surrounded by <code> tags and rendering poorly on page.

ISSUES CLOSED: #17911-freecodecamp https://github.com/freeCodeCamp/freeCodeCamp/issues/17911

Description

Pre-Submission Checklist

[x] Your pull request targets the dev branch.
[x] Branch starts with either fix/, feature/, or translate/ (e.g. fix/challenge-tests)
[x] All new and existing tests pass the command npm test.
[x] Use npm run commit to generate a conventional commit message. Learn more here: https://conventionalcommits.org/#why-use-conventional-commits
[x] The changes were done locally on your machine and NOT GitHub web interface. If they were done on the web interface you have ensured that you are creating conventional commit messages.

Checklist:

[x] Tested changes locally.
[x] Addressed currently open issue (replace XXXXX with an issue no in next line)

Closes #17911 https://github.com/freeCodeCamp/freeCodeCamp/issues/17911

scissorsneedfoodtoo commented 5 years ago

@GlynL, thank you for taking the time to fix this issue. However, I just noticed one small issue with the semicolon for one of your > character entities. The semicolon falls after the closing code tag after the <iframe> tag, so it's being rendered to the page. Could you change that section to the following?

"Your page could be put in a <code>&lt;frame&gt;</code> or <code>&lt;iframe&gt;</code> without your consent. This can result in clickjacking attacks, among other things. Clickjacking is a technique of tricking a user into interacting with a page different from what the user thinks it is. This can be obtained executing your page in a malicious context, by mean of iframing. In that context a hacker can put a hidden layer over your page. Hidden buttons can be used to run bad scripts. This middleware sets the X-Frame-Options header. It restricts who can put your site in a frame. It has three modes: DENY, SAMEORIGIN, and ALLOW-FROM.",

You seem very experienced with git, so I won't go into too much detail. After you make the changes you can use git commit --amend to use the same commit message before force pushing back to your remote branch. Once you've done that we should see the change here.

Let us know if we can help with anything!

GlynL commented 5 years ago

@scissorsneedfoodtoo Hi, Sorry about that mistake, wasn't able to work out linking it to the other repo's to properly test locally. I've made the adjustment now, thanks for the heads up.

scissorsneedfoodtoo commented 5 years ago

@GlynL, no need to apologize! It was such a minor thing I almost missed it myself. Hopefully we'll have an easier process to set up a local dev environment soon. Thank you for taking the time to fix this issue, and congratulations on your first contribution to freeCodeCamp! :+1: :+1: