Web Experience Toolkit is an Open source code library for building innovative websites that are accessible, usable, interoperable, mobile-friendly and multilingual. This collaborative open source project is led by the Government of Canada.
Table of Contents
Working examples
Purpose
The purpose of this repository is to allow for the development community to experiment with new concepts and features for future major iterations. All the code in this repository is explorative at best, and should not be viewed as official.
Code Quality
The code quality in this repository can be rather unstable from time to time, since most of the code is considered pre-alpha in terms of production quality. If you are interested in production ready code please refer to the main WET-BOEW repository.
Golden Rules to Remeber
- Try to self assign to issues it helps people know what everyone is working on.
- Make sure you only add the files you want to add, especially if you are not using a git ignore file.
- It is ok to compromise your local branch, but never the remote!
Making A Pull Request
- Be Clear And Specific
- Technically, GitHub allows you to submit a pull request with no comment at all. Try to use the comment box at all times. Carefully explain what the problem is and how your change fixes it. It’s also helpful to explain how the developer can recreate the problem you’re fixing. You can also include screenshots to show the tests and improvements you’ve done.
- Keep Changes Small
- You might see more than one bug that you’d like to fix. Be sure that if you do, submit them as two separate pull requests. A lengthy pull request is unlikely to be dealt with quickly. It could be difficult for us to try and follow your steps.
- Stick To Existing Conventions
- For Javascript portions of WET we follow the JQuery Style Guide style guide.
- Careful When You Copy-And-Paste Code
- Browsers can be very finicky about reading the spaces in code, and copy-paste adds new spaces you can’t even see.