mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 13:33:24 +00:00
docs: Update docs/contributing/ files to use channel.
Updates descriptive text that refer to Zulip channels in the `docs/contributing` files to use channel instead of stream. Part of the stream to channel rename project.
This commit is contained in:
committed by
Tim Abbott
parent
24e5e03d3f
commit
fdafda6e3a
@@ -9,16 +9,16 @@ lifetime of fine-tuning. This page offers some guidelines and resources that the
|
||||
## Where to ask your question
|
||||
|
||||
It is almost always best to ask questions and have a conversation in a public
|
||||
stream, rather than in direct messages. You’ll get better and faster answers
|
||||
channel, rather than in direct messages. You’ll get better and faster answers
|
||||
since many people can help, and it makes it possible for others to benefit from
|
||||
the discussion.
|
||||
|
||||
The [Zulip community
|
||||
guide](https://zulip.com/development-community/#where-do-i-send-my-message)
|
||||
offers guidelines on how the major public streams in the community are used.
|
||||
offers guidelines on how the major public channels in the community are used.
|
||||
Don’t stress too much about picking the right place if you’re not sure, as
|
||||
moderators can [move your question thread to a different
|
||||
stream](https://zulip.com/help/move-content-to-another-stream) if needed.
|
||||
channel](https://zulip.com/help/move-content-to-another-stream) if needed.
|
||||
|
||||
## How to ask a great question
|
||||
|
||||
|
||||
@@ -266,10 +266,10 @@ Some scenarios to consider:
|
||||
|
||||
- Try clicking on any interactive elements, multiple times, in a variety of orders.
|
||||
- If the feature affects the **message view**, try it out in different types of
|
||||
narrows: topic, stream, Combined feed, direct messages.
|
||||
narrows: topic, channel, Combined feed, direct messages.
|
||||
- If the feature affects the **compose box** in the web app, try both ways of
|
||||
[resizing the compose box](https://zulip.com/help/resize-the-compose-box).
|
||||
Test both stream messages and direct messages.
|
||||
Test both channel messages and direct messages.
|
||||
- If the feature might require **elevated permissions**, check it out as a user who has
|
||||
permissions to use it and one who does not.
|
||||
- Think about how the feature might **interact with other features**, and try out
|
||||
|
||||
@@ -193,7 +193,7 @@ a few rules to keep in mind:
|
||||
- `tests: Compile Handlebars templates with source maps.`
|
||||
- `blueslip: Add feature to time common operations.`
|
||||
- `gather_subscriptions: Fix exception handling bad input.`
|
||||
- `stream_settings: Fix save/discard widget on narrow screens.`
|
||||
- `channel_settings: Fix save/discard widget on narrow screens.`
|
||||
|
||||
#### Detailed example
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ array of users and organizations, and discussions in the development community
|
||||
are an incredibly valuable source of insight and ideas. We welcome all
|
||||
perspectives, respectfully shared.
|
||||
|
||||
Most design discussions take place in the [#design][design stream] stream in the
|
||||
Most design discussions take place in the [#design][design channel] channel in the
|
||||
development community. Discussions about mobile app design happen in
|
||||
[#mobile-team](https://chat.zulip.org/#narrow/stream/243-mobile-team), and
|
||||
design of the terminal app is discussed in
|
||||
@@ -39,7 +39,7 @@ your ideas:
|
||||
incompatible with Zulip's security model,” is important to present
|
||||
early.
|
||||
|
||||
Note that [#design][design stream] is a high-traffic stream, and thoughtful
|
||||
Note that [#design][design channel] is a high-traffic channel, and thoughtful
|
||||
participation takes time. Don’t let it prevent you from doing your own work. It
|
||||
can be helpful to pick particular conversations to follow, where you feel that
|
||||
you have insight to share.
|
||||
@@ -67,13 +67,13 @@ discussions:
|
||||
|
||||
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
|
||||
message in the [#design][design stream] stream in the Zulip development
|
||||
message in the [#design][design channel] channel in the Zulip development
|
||||
community.
|
||||
|
||||
### When to post
|
||||
|
||||
- The issue or a comment on your PR specifically asks you to get feedback in the
|
||||
[#design][design stream] stream.
|
||||
[#design][design channel] channel.
|
||||
|
||||
- The issue you’re working on is not specific about some design point, and you
|
||||
would like advice.
|
||||
@@ -162,25 +162,25 @@ If a conversation is going off-track and you are not sure how to fix it, please
|
||||
ping someone on the core team to intervene and help get the conversion into a
|
||||
better state.
|
||||
|
||||
### Moving threads to the most appropriate stream
|
||||
### Moving threads to the most appropriate channel
|
||||
|
||||
Sometimes it helps to move (part of) a thread to a different stream, so that
|
||||
Sometimes it helps to move (part of) a thread to a different channel, so that
|
||||
it's seen by the appropriate audience.
|
||||
|
||||
- We generally aim to discuss raw user feedback on the product’s design in
|
||||
[#feedback](https://chat.zulip.org/#narrow/stream/137-feedback).
|
||||
The [#design][design stream] should be reserved for design aspects that we’re
|
||||
The [#design][design channel] should be reserved for design aspects that we’re
|
||||
actively (considering) working on. This lets the design team focus on
|
||||
discussions that are expected to result in actionable decisions.
|
||||
|
||||
- If a discussion that started in another stream has shifted into the design
|
||||
phase, moving the discussion to [#design][design stream] helps the design team
|
||||
- If a discussion that started in another channel has shifted into the design
|
||||
phase, moving the discussion to [#design][design channel] helps the design team
|
||||
follow the conversation.
|
||||
|
||||
- Discussion of implementation-related decisions should ideally happen in
|
||||
[#frontend](https://chat.zulip.org/#narrow/stream/6-frontend). 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 stream.
|
||||
thread if there is an extensive conversation that belongs in the other channel.
|
||||
|
||||
- We use [#mobile-team](https://chat.zulip.org/#narrow/stream/243-mobile-team)
|
||||
for discussions of mobile app design, and
|
||||
@@ -268,4 +268,4 @@ to a decision:
|
||||
- If the thread has died down, and the decision makers feel that they have
|
||||
enough information to go on. (If they don’t, the thread can be bumped.)
|
||||
|
||||
[design stream]: https://chat.zulip.org/#narrow/stream/101-design
|
||||
[design channel]: https://chat.zulip.org/#narrow/stream/101-design
|
||||
|
||||
@@ -89,10 +89,10 @@ Steps and best practices for starting a conversation:
|
||||
1. [**Join** the Zulip development
|
||||
community](https://zulip.com/development-community/) if you don't already
|
||||
have an account.
|
||||
2. Pick an **appropriate stream** to report your issue:
|
||||
2. Pick an **appropriate channel** to report your issue:
|
||||
- [#issues](https://chat.zulip.org/#narrow/stream/9-issues) for issues with
|
||||
the Zulip web app or server. Use this stream if you aren't sure which
|
||||
stream is most appropriate.
|
||||
the Zulip web app or server. Use this channel if you aren't sure which
|
||||
channel is most appropriate.
|
||||
- [#mobile](https://chat.zulip.org/#narrow/stream/48-mobile) for issues with
|
||||
the mobile apps.
|
||||
- [#desktop](https://chat.zulip.org/#narrow/stream/16-desktop) for issues
|
||||
@@ -108,7 +108,7 @@ Steps and best practices for starting a conversation:
|
||||
discussing your issue, using a brief summary of the issue as the name of the topic.
|
||||
|
||||
If you aren't sure where to post or how to name your topic, don't worry!
|
||||
Moderators can always rename the topic, or move the thread to another stream.
|
||||
Moderators can always rename the topic, or move the thread to another channel.
|
||||
|
||||
Once a possible bug is reported, members of the development community will jump
|
||||
in to discuss whether the report constitutes a bug, how to reproduce it, and how
|
||||
@@ -133,7 +133,7 @@ renamed or resolved.
|
||||
impact, it is best to both file a GitHub issue and immediately start a
|
||||
discussion in the development community. This helps us address important
|
||||
issues as quickly as possible.
|
||||
- For minor bugs (e.g., a visual glitch in a settings menu for very long stream
|
||||
- For minor bugs (e.g., a visual glitch in a settings menu for very long channel
|
||||
names), filing a GitHub issue is sufficient.
|
||||
- If a potential bug discussed in the development community is confirmed to be
|
||||
an actual, reproducible bug, anyone can help out by filing a GitHub issue to
|
||||
|
||||
@@ -33,9 +33,9 @@ Steps and best practices for starting a conversation:
|
||||
1. [**Join** the Zulip development
|
||||
community](https://zulip.com/development-community/) if you don't already
|
||||
have an account.
|
||||
2. Pick an **appropriate stream** to discuss your idea:
|
||||
2. Pick an **appropriate channel** to discuss your idea:
|
||||
- [#feedback](https://chat.zulip.org/#narrow/stream/137-feedback) for suggestions for
|
||||
the Zulip web app or server. Use this stream if you aren't sure which stream is
|
||||
the Zulip web app or server. Use this channel if you aren't sure which channel is
|
||||
most appropriate.
|
||||
- [#mobile](https://chat.zulip.org/#narrow/stream/48-mobile) for suggestions
|
||||
for the mobile apps.
|
||||
@@ -51,7 +51,7 @@ Steps and best practices for starting a conversation:
|
||||
name of the topic.
|
||||
|
||||
If you aren't sure where to post or how to name your topic, don't worry!
|
||||
Moderators can always rename the topic, or move the thread to another stream.
|
||||
Moderators can always rename the topic, or move the thread to another channel.
|
||||
|
||||
Members of the development community will jump in to discuss your idea. You can
|
||||
help by participating in the discussion, including replying to any follow-up
|
||||
|
||||
Reference in New Issue
Block a user