Skip to content

Reformatted instructions for the first four ES6 challenges#12956

Merged
Greenheart merged 1 commit intofreeCodeCamp:stagingfrom
BrendanSweeny:fix/es6-formatting
Feb 1, 2017
Merged

Reformatted instructions for the first four ES6 challenges#12956
Greenheart merged 1 commit intofreeCodeCamp:stagingfrom
BrendanSweeny:fix/es6-formatting

Conversation

@BrendanSweeny
Copy link
Copy Markdown
Contributor

@BrendanSweeny BrendanSweeny commented Jan 29, 2017

Pre-Submission Checklist

  • Your pull request targets the staging branch of freeCodeCamp.
  • Branch starts with either fix/, feature/, or translate/ (e.g. fix/signin-issue)
  • You have only one commit (if not, squash them into one commit).
  • All new and existing tests pass the command npm test. Use git commit --amend to amend any fixes.

Type of Change

  • Small bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds new functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Add new translation (feature adding new translations)

Checklist:

  • Tested changes locally.
  • Closes currently open issue (replace XXXX with an issue no): Closes #XXXX

Progress towards issue #12698, which is a compiled list of QA tasks for the new ES6 section introduced in beta

Description

  • Updated instructions to fixed spelling/grammar mistakes and performed minor rewording for clarification.
  • Improved overall formatting of instructions by adding multi-line blockquotes for example code and by formatting inline code to identify variables and keywords in the instructions text.
  • Changed titles of challenges to better conform to the format used in the titles in the Basic Javascript section where appropriate.
  • Where appropriate, made minor changes to the challengeSeed syntax to conform with freeCodeCamp style guidelines (e.g. added a few semicolons, added spaces between function statement and function block, etc.) without changing functionality.
  • Made no improvements to the functionality of the tests for any of the challenges. That is still needed in some cases.

@BerkeleyTrue BerkeleyTrue added the status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. label Jan 29, 2017
@BrendanSweeny BrendanSweeny mentioned this pull request Jan 29, 2017
Closed
46 tasks
@Greenheart Greenheart self-requested a review January 30, 2017 20:34
Greenheart
Greenheart suggested changes Jan 30, 2017
View reviewed changes
Copy link
Copy Markdown
Member

@Greenheart Greenheart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BrendanSweeny Nice work on these fixes!

Some general thoughts:

  • Indentation for code examples: Should it be 4 or 2? I think 2 is common in other examples. Could you fix this while you're at it?

seed/challenges/02-javascript-algorithms-and-data-structures/es6.json Outdated

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

seed/challenges/02-javascript-algorithms-and-data-structures/es6.json Outdated

This comment was marked as off-topic.

Sign in to view

seed/challenges/02-javascript-algorithms-and-data-structures/es6.json Outdated

This comment was marked as off-topic.

Sign in to view

seed/challenges/02-javascript-algorithms-and-data-structures/es6.json Outdated

This comment was marked as off-topic.

Sign in to view

seed/challenges/02-javascript-algorithms-and-data-structures/es6.json Outdated

This comment was marked as off-topic.

Sign in to view

seed/challenges/02-javascript-algorithms-and-data-structures/es6.json Outdated

This comment was marked as off-topic.

Sign in to view

seed/challenges/02-javascript-algorithms-and-data-structures/es6.json Outdated

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

@BrendanSweeny
Copy link
Copy Markdown
Contributor Author

BrendanSweeny commented Jan 31, 2017

Good eye, @Greenheart ! Thanks for the feedback. I'll go ahead and format the various "use strict;" instances, correct the "Camper" indices and missing space. You are right about the two spaces vs four per the freeCodeCamp style guide, so I'll check each block of example code more closely.

@BrendanSweeny
Copy link
Copy Markdown
Contributor Author

BrendanSweeny commented Jan 31, 2017

I have amended my commit with the following changes:

  • Added "use strict" where necessary.
  • Fixed the indices for the newCampers array in the test messages and the missing space between Sam and Dav.
  • Changed 4-space indents to 2-space indents in blockquotes in the challenge instructions and the challengeSeeds where necessary.

Thanks for taking a look!

Greenheart
Greenheart reviewed Jan 31, 2017
View reviewed changes
Copy link
Copy Markdown
Member

@Greenheart Greenheart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BrendanSweeny Thanks for the update! This is looking great but I'm waiting to merge this for now as I think we should figure out what we want to do with the roleCall example in "Compare Scopes of the var and let keywords".

Hopefully we'll at the very least be able to merge this in the next few days 😄

@Greenheart Greenheart added the status: discussing Under discussion threads. Closed as stale after 60 days of inactivity. label Jan 31, 2017
@raisedadead
Copy link
Copy Markdown
Member

raisedadead commented Feb 1, 2017

@Greenheart just a thought, can we not merge this and track adding/modifying the example code in a separate issue?

@Greenheart Greenheart merged commit 2fea39f into freeCodeCamp:staging Feb 1, 2017
@BerkeleyTrue BerkeleyTrue removed the status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. label Feb 1, 2017
@Greenheart Greenheart mentioned this pull request Feb 1, 2017
Closed
@BrendanSweeny BrendanSweeny deleted the fix/es6-formatting branch February 2, 2017 02:38
@QuincyLarson
Copy link
Copy Markdown
Contributor

QuincyLarson commented Feb 7, 2017

@BrendanSweeny thanks for your help with these!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@erictleung erictleung erictleung left review comments

@Greenheart Greenheart Greenheart approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

status: discussing Under discussion threads. Closed as stale after 60 days of inactivity.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@BrendanSweeny @raisedadead @QuincyLarson @erictleung @Greenheart @BerkeleyTrue