Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JavaScript Best Practices #2412

Closed
Tracked by #2045
jonathanbossenger opened this issue Apr 30, 2024 · 11 comments
Closed
Tracked by #2045

JavaScript Best Practices #2412

jonathanbossenger opened this issue Apr 30, 2024 · 11 comments
Assignees

Comments

@jonathanbossenger
Copy link
Collaborator

jonathanbossenger commented Apr 30, 2024

Details

  • Content type (Online Workshop, Lesson, Course, Tutorial, or Lesson Plan): Lesson
  • Content title: JavaScript Best Practices
  • Topic description: Details on how to make use of built in JavaScript libraries, best practices to follow when writing JavaScript, and whether or not you should use jQuery.
  • Audience (User, Developer, Designer, Contributor, etc.):Developer
  • Experience Level (Beginner, Intermediate, Advanced, Any):Intermediate

Learning Objectives

  • Explain how to make use of any JavaScript libraries bundled with WordPress
  • Describe why theme developers should use these bundled libraries
  • Identify common JavaScript best practices when writing JavaScript
  • Determine whether jQuery is needed for theme development
  • Describe ways to implement and use jQuery safely, if it is needed.

Related Resources and Other Notes

Automation Code

//lesson

Copy link
Contributor

github-actions bot commented May 14, 2024

Lesson Development Checklist

  • Gather any relevant links to Support, Docs, or related material
  • Description and Objectives finalized
  • Lesson created and announced to the team for review
  • Lesson reviewed
  • Lesson video submitted and published to WPTV
  • Lesson created on Learn.WordPress.org
  • Lesson video published to YouTube
  • Lesson on Learn.WordPress.org updated with YouTube video
  • Lesson published to Learn.WordPress.org

@github-project-automation github-project-automation bot moved this to 👋 Ready to Create in LearnWP Content - Development May 14, 2024
@jonathanbossenger jonathanbossenger moved this from 👋 Ready to Create to 🔎 Ready for Review in LearnWP Content - Development May 14, 2024
@jonathanbossenger
Copy link
Collaborator Author

Video for review:

03-JavaScript.best.practices.mp4

@vagelisp
Copy link
Member

Nicely done.
I loved the "You might not need jQuery" reference.

@jonathanbossenger
Copy link
Collaborator Author

I loved the "You might not need jQuery" reference.

I enjoyed adding it as much as you enjoyed seeing it 😀 jQuery still has a special place in my heart, but I do appreciate that I don't need it anymore.

@rosswintle
Copy link

rosswintle commented May 16, 2024

Tutorial/Lessons Review Checklist

Please tick all items you've confirmed:

  • Learning outcomes/objectives are clear.
  • Technical concepts introduced in the content are accurate.
  • The speed of demonstrations are easy to follow.
  • The narration audio matches what is shown visually.
  • Spelling and grammar are correct.
  • Sound quality is consistent throughout the video.
  • Brand Usage Guidelines and Promotional Guidelines are being followed.
  • Media assets are all in the public domain (CC0).

Leave an additional comment below with feedback. You can also share what you liked about this Tutorial.

Nice. Great stuff. Only minor comments on the slides, though one of them should really be fixed up. (Yes, I AM the grammar police!! 👮‍♂️ )

  • [Optional] Slide at 0:38 - "Should you use jQuery" is a question and therefore worthy of a question mark.
  • [Optional] The slide used throughout with the specific list of tactics has inconsistent capitalisation ("Lint", "Loading")
  • [Must-fix] The second bullet on the jQuery slide (4:39) has something wrong in it: "jQuery is often no longer necessary to use jQuery for many common tasks"
  • [Optional] I suspect you won't change this, but I spotted that some of the URLs in the jQuery $.ajax example (at 5:03) are missing part of the path

@jonathanbossenger
Copy link
Collaborator Author

Thanks @rosswintle

Yes, I AM the grammar police!! 👮‍♂️
😄 never apologise for picking up these issues, I appreciate the thoroughness.

I suspect you won't change this, but I spotted that some of the URLs in the jQuery $.ajax example (at 5:03) are missing part of the path

Ironically, this one bugs me personally more than any of the other bugs you reported.

@jonathanbossenger
Copy link
Collaborator Author

Updated video:

03-JavaScript.best.practices.mp4

@jonathanbossenger jonathanbossenger moved this from 🔎 Ready for Review to ✅ Preparing to Publish in LearnWP Content - Development May 21, 2024
@jonathanbossenger
Copy link
Collaborator Author

@jonathanbossenger
Copy link
Collaborator Author

@jonathanbossenger
Copy link
Collaborator Author

@github-project-automation github-project-automation bot moved this from ✅ Preparing to Publish to 📜 Published or Closed in LearnWP Content - Development May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📜 Published or Closed
Development

No branches or pull requests

3 participants