Creating a pull request
Looking for WET v3.1?
WET v4.0 is now the current version. There is a new location for the Getting started page in WET v3.1.
Pull requests are welcome. Please make sure your changes are to the latest code and limit the commit range to just the files you intended to change (to avoid conflicts).
- To cut down on commit pollution in the main code base consider rebasing your commits before you create a pull request to the main branch.
New components
Should be added in a feature-* branch (e.g., feature-lightbox) that is created off of the master branch.
- Create the a fresh branch off master by using:
git fetch upstreamgit checkout upstream/mastergit checkout -b my-cool-new-feature
- Licensing for all new components and supporting code must be compatible with the MIT license used by WET.
- New plugins should use the same structure and formatas existing plugins.
- Include the WET terms and conditions comment block in all text-based source files that fall under Crown Copyright.
Bug fixes and patches that apply to all versions
Should be submitted to the master branch.
- Create a fresh branch off of master by using:
git fetch upstreamgit checkout upstream/mastergit checkout -b my-patch-description
Testing your PR before submitting
- Validate your HTML markup as to ensure well-formed HTML5.
- These tests will be run as part of the default build, or by calling
grunt htmllintto run the task on your built HTML. - You can manually test for well-formed markup using the W3C HTML validator. Validate with an XHTML5 preset and a checkmark next to "Be lax about HTTP Content-Type".
- These tests will be run as part of the default build, or by calling
- Validate your CSS with the following changes to the default settings:
- Profile: CSS level 3
- Vendor extensions: Warnings
- Validate your JavaScript code. This validation is done by calling
grunt jshint - Optimize your JavaScript, CSS and HTML code
- Formatting recommendations:
- Indenting can be enforced by installing an EditorConfig plugin for your prefered IDE
- Indent with tabs using the K&R indenting style
- Use single quotes for strings in JavaScript (so unescaped double quotes can be used for attributes in HTML output)
- Test Web pages against the following browser test baseline:
- The current and previous major version of each browser that accounts for at least 5 per cent of visits to the website;
- Any major version of a browser that, on its own, accounts for at least 5 per cent of visits to the website; and
- The current and previous versions of the default browsers of each mobile operating systems that accounts for at least 5 per cent of the global or Canadian mobile operating system market share.
- PR testing is done by Travis-CI, but the same set of tests can be run using "ant test" locally before you submit
- Date modified: