Skip to content

Contribution categories

delisma edited this page Sep 30, 2020 · 1 revision

7 types of contribution that can be made into GCWeb.

Stateless or basic components

Alerts, GC Feature, buttons, headings, etc.

Essentially a design contribution that mainly use CSS and HTML with little to no-JS. Contributing to the GCWeb provisional feature should allow you to avoid the overhead of contributing a stable feature which requires a lot of documentation and entreprise level testing.

Interactive components

Fieldflow, multimedia player, etc.

More in the vein of WET plugin but specifically to be used on Canada.ca or other GC websites. Use the provisional process to produce the CSS, HTML and JS for your component to GCWeb. If you're skinning a WET plugin to apply the Canada.ca brand, then this will not considered as an interactive component contribution, but more as a stateless or basic component.

Helper components

Grids, alignment, positioning, spacing, etc.

Considered more like utility classes, helper components for text, white space and more. This type of contribution can also leverage the provisional process.

Site wide components

Header, footer, breadcrumbs, menu, etc.

Before contributing to these components make sure you have talked to the DTO team. Since these components have a direct impact on the Canada.ca's brand, it is important to initiate a broader conversation about any changes. Once the conversations have concluded in a design decision, DTO will open a ticket with Principal Publisher to insure that the new components is available through GCWeb. Take note, these contributions often require to be written with the handlebars syntax.

Baseline layouts

Organisation of site wide components, social media, contact us, contributors, etc.

Same as site wide components, make sure you have talked to the DTO team.

Page layouts

Consultation, institutional profile, service initiation, etc.

In case of non mandatory page layouts, contributions to them doesn't required conversations with DTO. For mandatory page layouts, it is recommended to initiate a conversation with DTO but it is not mandatory. If you work on a non mandatory page layout it is recommended that you're confortable with the handlebars syntax. This will allow you to speed up the development process, and push directly to GCWeb. Otherwise, reach out to DTO to have your layout "prototyped" and sent to Principal Publisher for review.

General fixes

Bug fixes, typo in docs, task runners modification, etc.

In you find a typo in the GCWeb documentation or a bug in the code, you can open an issue and file a bug report on the GCWeb repo.

But before you open an issue:

  1. Is your issue is specific to WET-BOEW? File your issue in the WET-BOEW issue tracker.
  2. Is your issue is a general coding question? You might find general solutions to HTML, CSS, and JavaScript questions on StackOverflow.
  3. Is it related to an existing GCWeb issue? You could attend one of the weekly code sprint organized by Principal Publisher to discuss it further.

When creating an issue:

  1. Searched the existing issues to see if someone's already filed the same issue.
  2. Follow the bug report template in GitHub to reduce the back and forth required to fully grasp the issue