Prose Style Guide

link Formatting ConventionsOn many sites, prose (sites, README, docs, etc) is authored with GitHub Flavored Markdown. Some sites (e.g. api.jquery.com) use an XML-based markup system but the advice offered here for good writing still applies. link Writing StyleContent should be educational and accessible to a broad audience of developers. The primary target audience is beginning … Continue reading

JavaScript Style Guide

Linting Spacing Bad Examples Good Examples Object and Array Expressions Multi-line Statements Chained Method Calls Full File Closures Constructors Equality Type Checks Comments Quotes Semicolons Naming Conventions Global Variables DOM Node Rules Switch Statements link LintingUse JSHint to detect errors and potential problems. Every jQuery project has a Grunt task for linting all JavaScript files: … Continue reading

HTML Style Guide

Linting Spacing Formatting HTML Semantics Reducing Markup Separation of Concerns Forms Comments This page outlines the style guide for HTML pages in all jQuery projects. These rules apply to web sites, demo pages, inline examples, test pages, etc. Exceptions are allowed for pages that must violate the rules by their very nature, e.g., a page … Continue reading

CSS Style Guide

This page outlines the style guide for CSS across all jQuery projects. link LintingUse CSSLint to detect errors and potential problems. Most jQuery projects have a Grunt task for linting all CSS files: grunt csslint. The options for CSSLint are stored in a .csslintrc file. Each .csslintrc file follows a specific format. All options must … Continue reading

Contributing to jQuery Foundation Web Sites

Just like our JavaScript libraries, we maintain the design and content of all our websites in the open, with everything available on GitHub. We do this for several reasons: It works for code. Open source development is collaborative, auditable, and decentralized — all qualities that should be part of working on design and documentation as … Continue reading

Won’t Fix

link jQuery CorejQuery Core Won’t-Fix issues are tracked and explained on a jQuery Wiki page. link jQuery UIlink change EventWidgets that enhance form elements manipulate their element’s value programmatically, therefore we cannot guarantee that a native change event will fire when the element’s value changes. These widgets do all provide a custom change event. For … Continue reading

Supporting Other Users

With millions of jQuery users all over the world, there’s always someone out there who needs a helping hand. Like many open source projects, the jQuery Foundation relies on community support channels like forums, IRC, and StackOverflow. Helping out with support is one of the best first steps you can take to get involved in … Continue reading

Bug Triage

Triage, the process of reviewing incoming bug tickets, gathering more information about the situation, and verifying whether or not the report is valid, is a critical part of the day-to-day operation of all of our projects. Some new tickets are valuable reports of broken behavior, others are suggestions for enhancements both large and small, and … Continue reading

jQuery’s Style Guides

Style guides aim to make a code base appear as if it were written by one meticulous programmer. As with many aspects of coding and writing, there can be differences of opinion about the best style. Contentious issues like “spaces versus tabs” or “semicolons or not” distract from the goal of writing code that works. … Continue reading

jQuery Repository Maintainers Guide

This page is a collection of tips and tricks for dealing with pull requests and managing the jQuery git repositories on GitHub. link Fetch the Pull RequestGithub stores the refs for each pull request on the main repo. Assuming you have the jquery repo set as your upstream remote, you can use the following git … Continue reading