Contribution Guidelines: indicate that design guidelines will be needed when designing components
Closed, ResolvedPublic
Actions

Description

Background

In T343451: Component's guidelines: move the existing DSG component's guidelines to Codex the design guidelines have been included for all existing Codex components.

We will need to update the Design Contribution Guidelines to indicate that designers will need to create the design guidelines when designing new/existing Codex components.

Documentation

Google doc with the updated contribution guidelines

Acceptance criteria

Design

Update the design contribution guidelines in the doc for the following sections:
- Designing new components
- Redesigning existing components
Update the Phabricator task templates including guidelines as requirement for designers when designing new and existing components

Code

Update the following sections in the Codex site with this new documentation:
- Designing new components
- Redesigning existing components

Details

	Subject	Repo	Branch	Lines +/-
	Update Codex from v1.3.2 to v1.3.3	mediawiki/core	master	+1 K -164
	docs: add Components Guidelines when designing components	design/codex	main	+57 -9

Customize query in gerrit

Related Objects

Mentioned In: T345656: Component's guidelines: create guidelines for new Codex components
T343451: Component's guidelines: move the existing DSG component's guidelines to Codex
Mentioned Here: T341363: Accessibility check: update the Acceptance Criteria checklist in the component's task template
T343451: Component's guidelines: move the existing DSG component's guidelines to Codex

Event Timeline

bmartinezcalvo created this task.Aug 9 2023, 4:20 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 9 2023, 4:20 PM

bmartinezcalvo renamed this task from Design Contribution Guidelines: update them to explain that design guidelines will be needed when designing components to Contribution Guidelines: indicate that design guidelines will be needed when designing components.Aug 9 2023, 4:22 PM

bmartinezcalvo mentioned this in T343451: Component's guidelines: move the existing DSG component's guidelines to Codex.

CCiufo-WMF triaged this task as High priority.Aug 10 2023, 2:27 PM

CCiufo-WMF moved this task from Inbox to Design Upcoming on the Design-System-Team board.

CCiufo-WMF moved this task from Inbox to Contributor Experience on the Codex board.

bmartinezcalvo mentioned this in T345656: Component's guidelines: create guidelines for new Codex components.Sep 5 2023, 6:59 PM

Volker_E added projects: Documentation, Design.Oct 23 2023, 4:54 PM

bmartinezcalvo added a subscriber: CCiufo-WMF.Dec 4 2023, 10:03 AM

CCiufo-WMF moved this task from Design Upcoming to 2024 Quiet Week on the Design-System-Team board.Dec 14 2023, 2:21 PM

AnneT moved this task from 2024 Quiet Week to DST-Sprint-14 (2024-01-08 to 2024-01-19) on the Design-System-Team board.Jan 8 2024, 6:48 PM

AnneT edited projects, added Design-System-Team (DST-Sprint-14 (2024-01-08 to 2024-01-19)); removed Design-System-Team.

bmartinezcalvo claimed this task.Jan 10 2024, 2:32 PM

bmartinezcalvo moved this task from Committed to In Progress on the Design-System-Team (DST-Sprint-14 (2024-01-08 to 2024-01-19)) board.Jan 19 2024, 1:56 PM

bmartinezcalvo edited projects, added Design-System-Team (DST-Sprint-15 (2024-01-22 to 2024-02-02)); removed Design-System-Team (DST-Sprint-14 (2024-01-08 to 2024-01-19)).Jan 22 2024, 5:47 PM

CCiufo-WMF moved this task from Committed to In Progress on the Design-System-Team (DST-Sprint-15 (2024-01-22 to 2024-02-02)) board.Jan 22 2024, 5:47 PM

bmartinezcalvo updated the task description. (Show Details)Jan 23 2024, 10:46 AM

bmartinezcalvo updated the task description. (Show Details)

bmartinezcalvo updated the task description. (Show Details)Jan 23 2024, 6:26 PM

I've updated the Design Contribution Guidelines in this doc documenting how to include the component's guidelines when designing new and existing components. I've included the following sections:

Designing new components: Included a section for "Define the guidelines for this component" that will be included after the section "Design the component".
Redesigning existing components: Included a section for "Update the guidelines for this component" that will be included after the section "Design the component".

I've also updated the Phabricator task templates in both "Report and validate" sections in both new and existing components, including the Guidelines as a requirement for designers' work. Since there is this existing task T341363 that has not been implemented yet, I've also included the accessibility check as part of the acceptance criteria in these task templates. So in case we update these task templates we could solve it as well.

@DTorsani-WMF let me know your thoughts about these new sections included in the contribution guidelines before moving this task to Ready for development.

CCiufo-WMF changed the task status from Open to In Progress.Jan 23 2024, 7:45 PM

Change 995061 had a related patch set uploaded (by Bmartinezcalvo; author: Bmartinezcalvo):

[design/codex@main] docs: add Components Guidelines when designing components

https://gerrit.wikimedia.org/r/995061

gerritbot added a project: Patch-For-Review.Feb 1 2024, 5:14 PM

Change 995215 had a related patch set uploaded (by Bmartinezcalvo; author: Bmartinezcalvo):

[design/codex@main] Bug: T343910 Change-Id: I320195aa4d0618d0516462ee94f53b32f1e5d02f

https://gerrit.wikimedia.org/r/995215

Change 995215 abandoned by LWatson:

[design/codex@main] Bug: T343910 Change-Id: I320195aa4d0618d0516462ee94f53b32f1e5d02f

Reason:

Submitted this commit with two Change-Ids in error and will continue working on the initial commit.

https://gerrit.wikimedia.org/r/995215

bmartinezcalvo updated the task description. (Show Details)Feb 5 2024, 4:04 PM

Volker_E moved this task from In Progress to Code Review on the Design-System-Team (DST-Sprint-15 (2024-01-22 to 2024-02-02)) board.Feb 5 2024, 5:09 PM

lwatson edited projects, added Design-System-Team (DST-Sprint-16 (2024-02-05 to 2024-02-16)); removed Design-System-Team (DST-Sprint-15 (2024-01-22 to 2024-02-02)).Feb 6 2024, 2:18 PM

lwatson moved this task from Committed to Code Review on the Design-System-Team (DST-Sprint-16 (2024-02-05 to 2024-02-16)) board.

Change 995061 merged by jenkins-bot:

[design/codex@main] docs: add Components Guidelines when designing components

https://gerrit.wikimedia.org/r/995061

Maintenance_bot removed a project: Patch-For-Review.Feb 8 2024, 2:30 PM

lwatson moved this task from Code Review to Pending Release on the Design-System-Team (DST-Sprint-16 (2024-02-05 to 2024-02-16)) board.Feb 8 2024, 2:38 PM

Change 1005171 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/core@master] Update Codex from v1.3.2 to v1.3.3

https://gerrit.wikimedia.org/r/1005171

gerritbot added a project: Patch-For-Review.Feb 20 2024, 9:40 PM

Change 1005171 merged by jenkins-bot: