Internal project gouvernance - WET-BOEW documentatin

If you have any question please submit an github issue. If you want to participate, reach out Pierre Dubois where you can find he’s contact information on GCcollab, on GCconnect or send me a direct message on twitter.

Technical review meeting

Documents created via those meeting will be published on the wet-boew website.

Monthly meeting

Documents created via those meeting will be published on the wet-boew website. See our Office Hours wiki page for more information.

To participate

Adding new WET feature

  1. Describe the new features
    • For which audience
    • What is the desired behaviour
    • What is the need, what is the user end-goal
    • Summary and link to similar feature (What is doing, advantage, disavantage…)
  2. Look how current tools can be used to archive something similar
    • Describe the methodoly used
    • What work
    • What don’t work
  3. Research of similar tools
    • Name and small description of the tools
    • Links
    • Summary of the findings
    • Working examples
    • What sastisfied the requirement
    • What is missing
    • Concern (accessiblity, design pattern, configuration, integration, dependencies…)
  4. Develop the feature
    • Prototype
    • Optimize
    • Create working example (English and French)
    • Documentation (include API description)
  5. Submit PR with the new feature
    • Provide a link to a working example
    • Do an accessiblity assessment
    • Review code (style, optimisation, identify potential issue…)
    • Review the documentation
    • Review and validate the accuracy of the API based from the working example provided
    • Review the scope of that new feature, is it global, theme only or for a small sub-set of pages.
  6. Result of PR review
    1. Test passed and PR are merged in.
    2. Error was found and change are requested
    3. Concern was raised and
      • Instruction are provided on how to address concern, or
      • More details need to be provided to describe the concern, or
      • A mitigation plan would be proposed to address the concern

Github lableling

See the discussion on github - Issue #8026

Adding a new label

New label can be created on a need basis, but it’s description need to be detailed here.

Categories of labels:

Feature

A component of wet-boew that adds specific features or considerably support it. It include items related to:

Label color: #2a7da6

List of label:

Meta

Identify issue that are related to the wet-boew project and not directly for the maintaining one of it’s deliverable and features.

Label color: #e102d8

Need

Identify what is needed to move the issue forward.

Label color: #fbca04

Query

Identify what the issue is about.

Label color: #84b6eb

Severity

Identify the importance of the issue compared to the overhaul wet-boew project.

Accessibility issues are classified with an higher severity.

Label color: Each state have their own color.

Note:

State

Identify what state the issue is currently under. Useful when they are open for long period of time or for complex issue.

Label color: #EE8310

User Agent

Identify issue that is specific to a software agent.

Label color: #0b02e1

Work

Identify what kind of work it required to resolve the issue.

Label color: #8d201c

WET API (overview)