paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 13:33:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Clarify design-discussions as to #mobile-design vs. #design.

Browse Source 
We have an increasing number of design discussions about mobile
these days (which is great), and that means I've started to
regularly point people to this page -- particularly the section
"Guidelines for code contributors" -- as part of pointing them to
the #mobile-design channel to ask a design question.

In that context it seems confusing that it only talks about #design
and not #mobile-design.  We do mention the latter elsewhere on the
page, but I still feel I have to explain the discrepancy when
pointing to this section.  Fix it here instead.

This introduces to our docs the concept of "a design channel",
meaning #design and #mobile-design and sometimes #zulip-terminal.
This commit is contained in:
Greg Price
2025-01-21 21:29:06 -08:00
committed by Tim Abbott
parent fa06616f71
commit 9883e41436
1 changed files with 35 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/contributing/design-discussions.md
View File

@@ -67,13 +67,15 @@ discussions:
When you are working on a PR that includes frontend changes, you may find it helpful When you are working on a PR that includes frontend changes, you may find it helpful
to get interactive feedback on the design. The best way to do so is by posting a to get interactive feedback on the design. The best way to do so is by posting a
message in the [#design][design channel] channel in the Zulip development message in the appropriate design channel in the Zulip development
community. community: [#design][design channel] for the web/desktop app,
[#mobile-design][mobile-design channel] for the mobile app, or
[#zulip-terminal][zulip-terminal channel] for the terminal app.
### When to post ### When to post
- The issue or a comment on your PR specifically asks you to get feedback in the - The issue or a comment on your PR specifically asks you to get feedback in
[#design][design channel] channel. [#design][design channel] or another design channel.
- The issue you’re working on is not specific about some design point, and you - The issue you’re working on is not specific about some design point, and you
would like advice. would like advice.
@@ -168,8 +170,9 @@ Sometimes it helps to move (part of) a thread to a different channel, so that
it's seen by the appropriate audience. it's seen by the appropriate audience.
- We generally aim to discuss raw user feedback on the product’s design in - We generally aim to discuss raw user feedback on the product’s design in
[#feedback](https://chat.zulip.org/#narrow/channel/137-feedback). [#feedback](https://chat.zulip.org/#narrow/channel/137-feedback) (when it
The [#design][design channel] should be reserved for design aspects that we’re applies to the web and desktop apps, or to all Zulip clients). The
[#design][design channel] should be reserved for design aspects that we’re
actively (considering) working on. This lets the design team focus on actively (considering) working on. This lets the design team focus on
discussions that are expected to result in actionable decisions. discussions that are expected to result in actionable decisions.
@@ -178,13 +181,33 @@ it's seen by the appropriate audience.
follow the conversation. follow the conversation.
- Discussion of implementation-related decisions should ideally happen in - Discussion of implementation-related decisions should ideally happen in
[#frontend](https://chat.zulip.org/#narrow/channel/6-frontend). The line can non-design channels:
sometimes blur (and that’s OK), but we should aim to move (parts of) the [#frontend](https://chat.zulip.org/#narrow/channel/6-frontend) for the web
thread if there is an extensive conversation that belongs in the other channel. app, and see our [guide to chat.zulip.org
channels](https://zulip.com/development-community/#channels-for-code-contributors)
for other Zulip codebases. The line can sometimes blur (and that’s OK), but we
should aim to move (parts of) the thread if there is an extensive conversation
that belongs in the other channel.
- We use [#mobile-design][mobile-design channel] for discussions of - Similarly, for changes to the mobile app:
mobile app design, and [#zulip-terminal][zulip-terminal channel] for
terminal app design. - We aim to discuss raw user feedback in
[#mobile](https://chat.zulip.org/#narrow/channel/48-mobile).
The [#mobile-design][mobile-design channel] channel is reserved for design
aspects that we're actively (considering) working on.
- A discussion that has shifted into the design phase should be moved to
[#mobile-design][mobile-design channel], to help the design team closely
follow the discussion that calls for their input.
- Discussion of implementation details should move to
[#mobile-team](https://chat.zulip.org/#narrow/channel/243-mobile-team) or to
[#mobile-dev-help](https://chat.zulip.org/#narrow/channel/516-mobile-dev-help).
- Discussions of the mobile app's design should move to
[#mobile-design][mobile-design channel] (instead of #design), which the
mobile team follows closely.
Similarly, discussions of the design of the terminal app should move to
[#zulip-terminal][zulip-terminal channel].
## Guidelines for decision makers ## Guidelines for decision makers