Import challenge style guide into main repo
See original GitHub issueIssue Description
The CurriculumExpansion repository has a challenge style guide and I feel that this should be imported into the main repository (this one) and maintained and updated from here.
This will probably help in standardizing the challenges and address some of the concerns brought up in this issue’s thread https://github.com/freeCodeCamp/freeCodeCamp/issues/9291. Additionally, there have been questions (speaking from experience e.g. should I use <h4>Instructions</h4>
or <hr>
) when trying to remember or think about how something should be formatted. This is probably very valuable now when we’ve been formatting and prepping the new challenges for prime time.
cc/ @HKuz @QuincyLarson
Issue Analytics
- State:
- Created 7 years ago
- Reactions:5
- Comments:8 (8 by maintainers)
Top Results From Across the Web
Challenge exercise from the website www.frontendmentor.io
Frontend Mentor challenges help you improve your coding skills by building realistic projects. To do this challenge, you need a basic understanding of...
Read more >Digital Style Guide - NestJS support and code tweak - Topcoder
Browse the challenges currently available on Topcoder. Search by type of challenge, then find those of interest to register for and compete in...
Read more >Creating a Low Cost and Highly Automated Living Style Guide
Living style guide is an essential tool for designers and developers to create re-usable components. It is a central place to demonstrate ...
Read more >Build a Website Style Guide Challenge Project (HTML, CSS ...
I used flexbox to put this website together which is from the front -end course here in Codecademy, but I was unable to...
Read more >Git Workflow | Atlassian Git Tutorial
The Centralized Workflow is similar to other workflows in its utilization of a ... Otherwise, you'll need to import an existing Git or...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Completely agree, thanks for bringing this up @erictleung! I have a page of chicken-scratched notes I used as guidance when looking over the challenges on the curriculum-expansion branch.
In addition to what @no-stack-dub-sack mentions, I also have:
<strong>Note</strong><br>Text of note...
styleThis would definitely be helpful now since there are a number of contributors willing to help with pure formatting fixes in some sections.
I can certainly help with this, let me know 👍
@erictleung Ha! All the work I’ve been doing on challenges lately, and frankly, I never even knew this existed.
I think this is super helpful, and I think it should be updated to include actual style guidelines like:
<code>
tags<dfn>
tags<blockquote>
s<hr>
s (newly decided)And should also include tips like:
code
variableThese are all things that I didn’t know when I started contributing, that I had to just pick up along the way. If all this is included, I think it should be called just a “Challenge Writing Guide” and should be pointed to from somewhere in the main
CONTRIBUTING.md
file somewhere very obvious, so that new contributors don’t have to struggle to figure out how to conform to our guidelines.Although… I think this part of the guide is nuts based on our current map and feel it should be removed:
Our current challenges in no way uphold this rule, and they wouldn’t be any fun if they did. The algorithm sections in particular can take some folks hours or days to solve! Perhaps this should just be clarified based on section.