2021-07-20 20:45:23 +02:00
|
|
|
|
The primary communication forum for the Zulip community is the Zulip
|
|
|
|
|
server hosted at [chat.zulip.org](https://chat.zulip.org/):
|
|
|
|
|
|
|
|
|
|
- **Users** and **administrators** of Zulip organizations stop by to
|
|
|
|
|
ask questions, offer feedback, and participate in product design
|
|
|
|
|
discussions.
|
|
|
|
|
- **Contributors to the project**, including the **core Zulip
|
|
|
|
|
development team**, discuss ongoing and future projects, brainstorm
|
|
|
|
|
ideas, and generally help each other out.
|
|
|
|
|
|
|
|
|
|
Everyone is welcome to [sign up](https://chat.zulip.org/) and
|
2024-05-06 19:38:12 +02:00
|
|
|
|
participate — we love hearing from our users! Public channels in the
|
2021-07-20 20:45:23 +02:00
|
|
|
|
community receive thousands of messages a week. We recommend signing
|
|
|
|
|
up using the special invite links for
|
|
|
|
|
[users](https://chat.zulip.org/join/t5crtoe62bpcxyisiyglmtvb/),
|
|
|
|
|
[self-hosters](https://chat.zulip.org/join/wnhv3jzm6afa4raenedanfno/)
|
|
|
|
|
and
|
|
|
|
|
[contributors](https://chat.zulip.org/join/npzwak7vpmaknrhxthna3c7p/)
|
2024-05-06 19:38:12 +02:00
|
|
|
|
to get a curated list of initial channel subscriptions.
|
2021-07-20 20:45:23 +02:00
|
|
|
|
|
|
|
|
|
To get help in real time, you will have the best luck finding core
|
|
|
|
|
developers during daylight hours in North America (roughly between
|
|
|
|
|
15:00 UTC and 1:00 UTC), but the sun never sets on the Zulip
|
|
|
|
|
community. Most questions get a reply within minutes to a few hours.
|
|
|
|
|
|
2023-03-14 22:12:29 +01:00
|
|
|
|
You can also [read conversations](https://chat.zulip.org/) in the community
|
|
|
|
|
without creating an account. If you are evaluating using Zulip for your
|
|
|
|
|
organization, check out these [tips](/try-zulip/) for exploring the product in
|
|
|
|
|
action in the development community.
|
|
|
|
|
|
2021-07-26 06:58:45 +02:00
|
|
|
|
<br/>
|
2021-07-20 20:45:23 +02:00
|
|
|
|
# Community norms
|
|
|
|
|
|
|
|
|
|
Zulip is a friendly and welcoming community, and we love meeting new
|
|
|
|
|
people, hearing about what brought them to Zulip, and getting their
|
|
|
|
|
feedback.
|
|
|
|
|
|
|
|
|
|
## Getting started
|
|
|
|
|
|
|
|
|
|
- Send test messages to [#test
|
2024-06-06 21:48:31 +02:00
|
|
|
|
here](https://chat.zulip.org/#narrow/channel/7-test-here) or as a PM
|
2021-07-20 20:45:23 +02:00
|
|
|
|
to yourself to avoid disturbing others.
|
2024-05-07 09:51:46 +02:00
|
|
|
|
- Start a [new topic](/help/introduction-to-topics) unless you’re replying
|
2021-07-20 20:45:23 +02:00
|
|
|
|
to an existing conversation. If you see a new user talking about
|
|
|
|
|
something unrelated on an existing topic, [move the messages to an
|
|
|
|
|
appropriate new topic](/help/move-content-to-another-topic).
|
|
|
|
|
- If you’re not sure where to start, introduce yourself and your
|
|
|
|
|
interests in [#new
|
2024-06-06 21:48:31 +02:00
|
|
|
|
members](https://chat.zulip.org/#narrow/channel/95-new-members),
|
2021-07-20 20:45:23 +02:00
|
|
|
|
using your name as the topic to create a dedicated space.
|
|
|
|
|
- Follow the community [code of
|
|
|
|
|
conduct](https://zulip.readthedocs.io/en/latest/code-of-conduct.html).
|
|
|
|
|
|
|
|
|
|
## Communication style
|
|
|
|
|
|
|
|
|
|
- Converse informally; there’s no need to use titles like “Sir” or “Madam”.
|
|
|
|
|
- Use [gender-neutral
|
|
|
|
|
language](https://en.wikipedia.org/wiki/Gender-neutral_language). For
|
|
|
|
|
example, avoid using a pronoun like “her” or “his” in sentences like
|
|
|
|
|
“Every developer should clean [their] keyboard at least once a
|
|
|
|
|
week.”
|
|
|
|
|
|
|
|
|
|
## Getting help
|
|
|
|
|
- When asking for help, provide the details needed for others to help
|
|
|
|
|
you. For example, include the **full traceback** in a [code
|
|
|
|
|
block](/help/code-blocks) (not a screenshot), a link to the code or
|
2022-06-24 06:33:47 +02:00
|
|
|
|
a draft PR you’re having trouble debugging, etc.
|
2024-05-06 19:38:12 +02:00
|
|
|
|
- Ask questions on channels rather than DMing core contributors. You’ll
|
2021-07-20 20:45:23 +02:00
|
|
|
|
get answers faster since other people can help, and it makes it
|
|
|
|
|
possible for others to benefit from the discussion.
|
|
|
|
|
- Don’t ask the same question in multiple places. Moderators read
|
2024-05-06 19:38:12 +02:00
|
|
|
|
every public channel, and make sure every question gets a reply.
|
2023-06-08 03:00:08 +02:00
|
|
|
|
- Use @-mentions sparingly. Unlike IRC or Slack, Zulip’s topics make
|
2021-07-20 20:45:23 +02:00
|
|
|
|
it easy to see what you’re replying to, so you don’t need to mention
|
|
|
|
|
your conversation partner to make sure they will see or understand
|
|
|
|
|
your reply. Core contributors will often @-mention someone who asked
|
|
|
|
|
a question hours earlier to make sure they see the reply, but there
|
|
|
|
|
is generally no need to @-mention a core contributor unless you need
|
|
|
|
|
their timely attention.
|
|
|
|
|
|
2021-07-26 06:58:45 +02:00
|
|
|
|
<br/>
|
2021-07-20 20:45:23 +02:00
|
|
|
|
# Where do I send my message?
|
|
|
|
|
|
2024-05-06 19:38:12 +02:00
|
|
|
|
This section describes popular public channels on chat.zulip.org. Kick
|
2024-05-07 09:51:46 +02:00
|
|
|
|
off the discussion by starting a [new topic](/help/introduction-to-topics)
|
2024-05-06 19:38:12 +02:00
|
|
|
|
in the appropriate channel! Don’t stress too much about picking the
|
2021-07-20 20:45:23 +02:00
|
|
|
|
right place if you’re not sure; anyone in the community can edit a
|
|
|
|
|
topic name, and [moderators](/help/roles-and-permissions) can [move a
|
2024-05-06 19:38:12 +02:00
|
|
|
|
topic to a different channel](/help/move-content-to-another-channel).
|
2021-07-20 20:45:23 +02:00
|
|
|
|
|
2024-05-06 19:38:12 +02:00
|
|
|
|
## Channels for everyone
|
2023-12-11 19:16:26 +01:00
|
|
|
|
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#feedback](https://chat.zulip.org/#narrow/channel/137-feedback) is
|
2023-12-11 19:16:26 +01:00
|
|
|
|
for posting feedback on Zulip, including feature requests, suggestions for
|
|
|
|
|
improvements to the UI or existing features, or anything else! We also
|
|
|
|
|
appreciate hearing about how Zulip is used in your organization.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#integrations](https://chat.zulip.org/#narrow/channel/127-integrations)
|
2023-12-11 19:16:26 +01:00
|
|
|
|
is for bug reports or questions about integrations.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#issues](https://chat.zulip.org/#narrow/channel/9-issues) is for reporting
|
2023-12-11 19:16:26 +01:00
|
|
|
|
bugs (or possible bugs) in the Zulip web app or server implementation.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#mobile](https://chat.zulip.org/#narrow/channel/48-mobile),
|
|
|
|
|
[#desktop](https://chat.zulip.org/#narrow/channel/16-desktop), and
|
|
|
|
|
[#zulip-terminal](https://chat.zulip.org/#narrow/channel/206-zulip-terminal)
|
2023-12-11 19:16:26 +01:00
|
|
|
|
are the best places to post bug reports or questions about Zulip's apps. Note
|
2024-06-06 21:48:31 +02:00
|
|
|
|
that [#desktop](https://chat.zulip.org/#narrow/channel/16-desktop) should only
|
2023-12-11 19:16:26 +01:00
|
|
|
|
be used for issues specific to the desktop app, which shares most of its UI
|
|
|
|
|
and implementation with the web app.
|
2021-07-20 20:45:23 +02:00
|
|
|
|
- Everyone is welcome to introduce themselves in [#new
|
2024-06-06 21:48:31 +02:00
|
|
|
|
members](https://chat.zulip.org/#narrow/channel/95-new-members). Posting
|
2021-07-20 20:45:23 +02:00
|
|
|
|
here with your name as the topic is a great option if you’re
|
|
|
|
|
uncertain where to start a conversation.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#test here](https://chat.zulip.org/#narrow/channel/7-test-here) is
|
2021-07-20 20:45:23 +02:00
|
|
|
|
for sending test messages without inconveniencing other users :). We
|
2024-05-06 19:38:12 +02:00
|
|
|
|
recommend muting this channel when not using it.
|
2021-07-20 20:45:23 +02:00
|
|
|
|
|
2024-05-06 10:02:54 +02:00
|
|
|
|
## Channels for Zulip users and administrators
|
2021-07-20 20:45:23 +02:00
|
|
|
|
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#user questions](https://chat.zulip.org/#narrow/channel/138-user-questions) is
|
2023-12-11 19:16:26 +01:00
|
|
|
|
for questions about how to configure your Zulip organization, and accomplish
|
|
|
|
|
your goals with Zulip. You can also refer to the [Zulip help center](/help)
|
|
|
|
|
for detailed documentation.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#production help](https://chat.zulip.org/#narrow/channel/31-production-help) is
|
2021-07-20 20:45:23 +02:00
|
|
|
|
for all questions related to [self-hosting
|
2021-10-16 01:12:43 +02:00
|
|
|
|
Zulip](/self-hosting/).
|
2021-07-20 20:45:23 +02:00
|
|
|
|
- [#zulip
|
2024-06-06 21:48:31 +02:00
|
|
|
|
cloud](https://chat.zulip.org/#narrow/channel/387-zulip-cloud) is for
|
2021-07-20 20:45:23 +02:00
|
|
|
|
all conversations about the [Zulip Cloud](https://zulip.com/plans/)
|
|
|
|
|
service.
|
|
|
|
|
|
2024-05-06 19:38:12 +02:00
|
|
|
|
## Channels for code contributors
|
2021-07-20 20:45:23 +02:00
|
|
|
|
|
|
|
|
|
- [#development
|
2024-06-06 21:48:31 +02:00
|
|
|
|
help](https://chat.zulip.org/#narrow/channel/49-development-help) is
|
2021-07-20 20:45:23 +02:00
|
|
|
|
for asking for help with any Zulip server/web app development work
|
2024-07-10 03:00:09 +02:00
|
|
|
|
(use the app channels #mobile-dev-help, #desktop, or #zulip-terminal for help
|
2021-07-20 20:45:23 +02:00
|
|
|
|
working on one of the apps).
|
|
|
|
|
- [#provision
|
2024-06-06 21:48:31 +02:00
|
|
|
|
help](https://chat.zulip.org/#narrow/channel/21-provision-help) is
|
2021-07-20 20:45:23 +02:00
|
|
|
|
for help specifically on setting up the server/web app development
|
2024-06-06 21:48:31 +02:00
|
|
|
|
environment. [#tools](https://chat.zulip.org/#narrow/channel/18-tools)
|
2021-07-20 20:45:23 +02:00
|
|
|
|
is other conversations about the server/web app developer tooling.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#git help](https://chat.zulip.org/#narrow/channel/44-git-help) is
|
2021-07-20 20:45:23 +02:00
|
|
|
|
for help with using Git.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#code review](https://chat.zulip.org/#narrow/channel/91-code-review)
|
2021-07-20 20:45:23 +02:00
|
|
|
|
is for getting feedback on your work. We encourage all developers to
|
|
|
|
|
comment on work posted here, even if you’re new to the Zulip
|
|
|
|
|
project; reviewing other PRs is a great way to develop experience,
|
|
|
|
|
and even just manually testing a proposed new feature and posting
|
2023-04-20 23:59:48 +02:00
|
|
|
|
feedback is super helpful. Note that GitHub is our primary system
|
|
|
|
|
for managing code reviews.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#backend](https://chat.zulip.org/#narrow/channel/3-backend),
|
|
|
|
|
[#frontend](https://chat.zulip.org/#narrow/channel/6-frontend),
|
|
|
|
|
[#documentation](https://chat.zulip.org/#narrow/channel/19-documentation),
|
2024-05-06 19:38:12 +02:00
|
|
|
|
and app-specific channels
|
2024-07-10 02:59:47 +02:00
|
|
|
|
([#mobile-team](https://chat.zulip.org/#narrow/channel/243-mobile-team), etc.)
|
2021-07-20 20:45:23 +02:00
|
|
|
|
are the right place for general conversations about work in those
|
|
|
|
|
areas (including design discussions, questions, updates on a
|
|
|
|
|
project, or anything else).
|
|
|
|
|
- [#automated
|
2024-06-06 21:48:31 +02:00
|
|
|
|
testing](https://chat.zulip.org/#narrow/channel/43-automated-testing)
|
2021-07-20 20:45:23 +02:00
|
|
|
|
is primarily used for automated notifications about [CI
|
|
|
|
|
failures](https://zulip.readthedocs.io/en/latest/testing/continuous-integration.html),
|
|
|
|
|
but is also a good place to discuss projects to improve Zulip’s
|
|
|
|
|
automated testing infrastructure.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#api design](https://chat.zulip.org/#narrow/channel/378-api-design)
|
2024-05-06 19:38:12 +02:00
|
|
|
|
is a low-traffic channel for discussing and coordinating changes to
|
2021-07-20 20:45:23 +02:00
|
|
|
|
the [Zulip API](https://zulip.com/api/rest), with all stakeholders
|
|
|
|
|
present.
|
|
|
|
|
|
2024-05-06 19:38:12 +02:00
|
|
|
|
## Channels for translators
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#translation](https://chat.zulip.org/#narrow/channel/58-translation)
|
2021-07-20 20:45:23 +02:00
|
|
|
|
is for discussing [Zulip’s
|
|
|
|
|
translations](https://zulip.readthedocs.io/en/latest/translating/translating.html).
|
2024-05-06 19:38:12 +02:00
|
|
|
|
- Some languages have channels named like
|
2024-06-06 21:48:31 +02:00
|
|
|
|
[#translation/fr](https://chat.zulip.org/#narrow/channel/371-translation.2Ffr)
|
2021-07-20 20:45:23 +02:00
|
|
|
|
and
|
2024-06-06 21:48:31 +02:00
|
|
|
|
[#translation/zh_tw](https://chat.zulip.org/#narrow/channel/377-translation.2Fzh_tw)
|
2021-07-20 20:45:23 +02:00
|
|
|
|
to coordinate translation work for that language.
|
|
|
|
|
|
2024-05-06 19:38:12 +02:00
|
|
|
|
## Channels for anyone spending time in the community
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#announce](https://chat.zulip.org/#narrow/channel/1-announce) is our
|
2024-05-06 19:38:12 +02:00
|
|
|
|
low-traffic channel for project announcements (releases, etc.).
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#checkins](https://chat.zulip.org/#narrow/channel/65-checkins) is
|
2021-07-20 20:45:23 +02:00
|
|
|
|
for progress updates on what you’re working on and its status;
|
|
|
|
|
usually folks post with their name as the topic. Everyone is welcome
|
|
|
|
|
to participate!
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#design](https://chat.zulip.org/#narrow/channel/101-design) is where
|
2021-07-20 20:45:23 +02:00
|
|
|
|
we discuss UI and feature design and collect feedback on potential
|
|
|
|
|
design changes. We love feedback, so don’t hesitate to speak up!
|
|
|
|
|
Note that
|
2024-06-06 21:48:31 +02:00
|
|
|
|
[#feedback](https://chat.zulip.org/#narrow/channel/137-feedback) is
|
2021-07-20 20:45:23 +02:00
|
|
|
|
usually the best place for end users to start a topic about a
|
|
|
|
|
proposed design change;
|
2024-06-06 21:48:31 +02:00
|
|
|
|
[#design](https://chat.zulip.org/#narrow/channel/101-design) is
|
2021-07-20 20:45:23 +02:00
|
|
|
|
primarily intended for discussing changes the community is actively
|
|
|
|
|
working on.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#discussions](https://chat.zulip.org/#narrow/channel/277-discussions)
|
2021-07-20 20:45:23 +02:00
|
|
|
|
is where we do fun community conversations like “Ask Me Anything”
|
|
|
|
|
Q&A sessions with project members.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#documentation](https://chat.zulip.org/#narrow/channel/19-documentation)
|
2021-07-20 20:45:23 +02:00
|
|
|
|
is where we discuss improving Zulip’s user, sysadmin, API, and
|
|
|
|
|
developer documentation.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#general](https://chat.zulip.org/#narrow/channel/2-general) is for
|
2021-07-20 20:45:23 +02:00
|
|
|
|
all topics of general interest.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#learning](https://chat.zulip.org/#narrow/channel/92-learning) is
|
2021-07-20 20:45:23 +02:00
|
|
|
|
for posting great learning resources one comes across.
|
2024-06-06 21:48:31 +02:00
|
|
|
|
- [#off topic](https://chat.zulip.org/#narrow/channel/97-off-topic) is
|
2021-07-20 20:45:23 +02:00
|
|
|
|
is for occasional conversations not related to Zulip, usually things
|
|
|
|
|
of general interest to open-source communities.
|
|
|
|
|
|
2024-05-06 19:38:12 +02:00
|
|
|
|
You can always find the description for the channel you’re reading at
|
2021-07-20 20:45:23 +02:00
|
|
|
|
the top of the Zulip app.
|
|
|
|
|
|
2021-07-26 06:58:45 +02:00
|
|
|
|
<br/>
|
2021-07-20 20:45:23 +02:00
|
|
|
|
# Anything else to keep in mind?
|
|
|
|
|
|
|
|
|
|
## Don’t try to read *everything*
|
|
|
|
|
|
|
|
|
|
Keeping up with **everything** happening in the Zulip project is both
|
|
|
|
|
difficult and rarely a useful goal. To make the best use of your time,
|
2024-05-06 19:38:12 +02:00
|
|
|
|
we highly recommend that you unsubscribe from channels that you aren’t
|
|
|
|
|
interested in, mute channels that are only of occasional interest, and
|
2021-07-20 20:45:23 +02:00
|
|
|
|
make use of [Zulip’s skimming features](/help/reading-strategies),
|
2022-10-12 19:54:34 +02:00
|
|
|
|
like Recent conversations, to spend your time on topics that interest
|
2021-07-20 20:45:23 +02:00
|
|
|
|
you.
|
|
|
|
|
|
|
|
|
|
## Searching for past conversations
|
|
|
|
|
|
|
|
|
|
To look for previous threads about something, we recommend using the
|
2022-12-09 22:19:28 +01:00
|
|
|
|
following [search filters](/help/search-for-messages#search-filters):
|
2021-07-20 20:45:23 +02:00
|
|
|
|
`streams:public <your keyword(s)>`.
|
|
|
|
|
|
2024-05-06 19:38:12 +02:00
|
|
|
|
This will search the full history of all public channels for `<your
|
2021-07-20 20:45:23 +02:00
|
|
|
|
keyword(s)>`, including messages sent before you joined and messages
|
2024-05-06 19:38:12 +02:00
|
|
|
|
on public channels you’re not subscribed to.
|
2021-07-20 20:45:23 +02:00
|
|
|
|
|
2023-03-07 13:38:52 +01:00
|
|
|
|
## Linking to GitHub issues and pull requests
|
|
|
|
|
|
|
|
|
|
We've set up [custom linkifiers](/help/add-a-custom-linkifier)
|
|
|
|
|
so that it's easy to link to issues and pull requests in Zulip
|
2024-05-06 20:32:07 +02:00
|
|
|
|
project repositories when composing a message or starting a
|
2024-05-07 09:51:46 +02:00
|
|
|
|
[new topic](/help/introduction-to-topics). Here are examples for linking
|
2023-03-07 13:38:52 +01:00
|
|
|
|
to issue 1234 in the main Zulip project repositories:
|
|
|
|
|
|
|
|
|
|
- [Server and web app][server-web-repository]: `#1234`
|
2024-03-19 13:05:26 +01:00
|
|
|
|
- [Flutter mobile client][flutter-repository]: `#F1234`
|
2023-03-07 13:38:52 +01:00
|
|
|
|
- [Terminal client][terminal-repository]: `#T1234`
|
|
|
|
|
- [Desktop client][desktop-repository]: `#D1234`
|
2024-03-19 13:05:26 +01:00
|
|
|
|
- [React Native mobile client][mobile-repository]: `#M1234`
|
2023-03-07 13:38:52 +01:00
|
|
|
|
|
2021-07-20 20:45:23 +02:00
|
|
|
|
## New features are tested here
|
|
|
|
|
|
|
|
|
|
We [continuously test out new features or ideas][release-lifecycle] on
|
|
|
|
|
chat.zulip.org before rolling them out to Zulip Cloud or including
|
|
|
|
|
them in a Zulip Server release (or deciding not to!). Please report in
|
2024-06-06 21:48:31 +02:00
|
|
|
|
[#issues](https://chat.zulip.org/#narrow/channel/9-issues) anything you
|
2023-03-07 13:38:52 +01:00
|
|
|
|
notice that seems broken! It’s likely you’ve found a bug in an upcoming
|
|
|
|
|
feature.
|
2021-07-20 20:45:23 +02:00
|
|
|
|
|
|
|
|
|
[release-lifecycle]: https://zulip.readthedocs.io/en/latest/overview/release-lifecycle.html
|
2023-03-07 13:38:52 +01:00
|
|
|
|
[server-web-repository]: https://github.com/zulip/zulip
|
2024-03-19 13:05:26 +01:00
|
|
|
|
[flutter-repository]: https://github.com/zulip/zulip-flutter
|
2023-03-07 13:38:52 +01:00
|
|
|
|
[mobile-repository]: https://github.com/zulip/zulip-mobile
|
|
|
|
|
[terminal-repository]: https://github.com/zulip/zulip-terminal
|
|
|
|
|
[desktop-repository]: https://github.com/zulip/zulip-desktop
|