Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

README: Harmonize references to development list and chat. 

Also update one reference to the list to instead point to
a chat stream.
This commit is contained in:
Greg Price 2017-06-07 13:30:43 -07:00 committed by Tim Abbott
parent e1110308fc
commit 89a15e67de
1 changed files with 34 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -26,23 +26,24 @@ at <https://www.zulip.org>.
There are several places online where folks discuss Zulip. There are several places online where folks discuss Zulip.
* The primary place is the * The primary place is the
[Zulip development community Zulip server](https://zulip.readthedocs.io/en/latest/chat-zulip-org.html). [Zulip development community Zulip server][czo-doc] at
chat.zulip.org.
* For Google Summer of Code students and applicants, we have * For Google Summer of Code students and applicants, we have
[a mailing list](https://groups.google.com/forum/#!forum/zulip-gsoc) [a mailing list](https://groups.google.com/forum/#!forum/zulip-gsoc)
for help, questions, and announcements. But it's often simpler to for help, questions, and announcements. But it's often simpler to
visit chat.zulip.org instead. [visit chat.zulip.org][czo-doc] instead.
* We have * We have a [public development discussion mailing list][zulip-devel],
[a public mailing list](https://groups.google.com/forum/#!forum/zulip-devel) zulip-devel, which is currently pretty low traffic because most
that is currently pretty low traffic because most discussions happen discussions happen in our public Zulip instance. We use it to
in our public Zulip instance. We use it to announce Zulip developer announce Zulip developer community gatherings and ask for feedback on
community gatherings and ask for feedback on major technical or design major technical or design decisions. It has several hundred
decisions. It has several hundred subscribers, so you can use it to subscribers, so you can use it to ask questions about features or
ask questions about features or possible bugs, but please don't use it possible bugs, but please don't use it ask for generic help getting
ask for generic help getting started as a contributor (e.g. because started as a contributor (e.g. because you want to do Google Summer of
you want to do Google Summer of Code). The rest of this page covers Code). The rest of this page covers how to get involved in the Zulip
how to get involved in the Zulip project in detail. project in detail.
* Zulip also has a [blog](https://blog.zulip.org/) and * Zulip also has a [blog](https://blog.zulip.org/) and
[twitter account](https://twitter.com/zuliposs). [twitter account](https://twitter.com/zuliposs).
@ -55,6 +56,8 @@ as our primary mechanism to receive code contributions.
The Zulip community has a [Code of Conduct][code-of-conduct]. The Zulip community has a [Code of Conduct][code-of-conduct].
[zulip-devel]: https://groups.google.com/forum/#!forum/zulip-devel
## Installing the Zulip Development environment ## Installing the Zulip Development environment
The Zulip development environment is the recommended option for folks The Zulip development environment is the recommended option for folks
@ -123,11 +126,10 @@ contributing!
* **Code Reviews**. Zulip is all about community and helping each * **Code Reviews**. Zulip is all about community and helping each
other out. Check out [#code review][code-review] on other out. Check out [#code review][code-review] on
[chat.zulip.org](https://zulip.readthedocs.io/en/latest/chat-zulip-org.html) [chat.zulip.org][czo-doc] to help review PRs and give comments on
to help review PRs and give comments on other people's work. Everyone is other people's work. Everyone is welcome to participate, even those
welcome to participate, even those new to Zulip! Even just checking out new to Zulip! Even just checking out the code, manually testing it,
the code, manually testing it, and posting on whether or not it worked and posting on whether or not it worked is valuable.
is valuable.
[cla]: https://opensource.dropbox.com/cla/ [cla]: https://opensource.dropbox.com/cla/
[code-of-conduct]: https://zulip.readthedocs.io/en/latest/code-of-conduct.html [code-of-conduct]: https://zulip.readthedocs.io/en/latest/code-of-conduct.html
@ -225,11 +227,10 @@ label the issue as **in progress**. For more details, check out
You're encouraged to ask questions on how to best implement or debug You're encouraged to ask questions on how to best implement or debug
your changes -- the Zulip maintainers are excited to answer questions your changes -- the Zulip maintainers are excited to answer questions
to help you stay unblocked and working efficiently. It's great to ask to help you stay unblocked and working efficiently. It's great to ask
questions in comments on GitHub issues and pull requests, or [on questions in comments on GitHub issues and pull requests, or
chat.zulip.org](https://zulip.readthedocs.io/en/latest/chat-zulip-org.html). We'll [on chat.zulip.org][czo-doc]. We'll direct longer discussions to
direct longer discussions to Zulip chat, but please post a summary of Zulip chat, but please post a summary of what you learned from the
what you learned from the chat, or link to the conversation, in a chat, or link to the conversation, in a comment on the GitHub issue.
comment on the GitHub issue.
We also welcome suggestions of features that you feel would be We also welcome suggestions of features that you feel would be
valuable or changes that you feel would make Zulip a better open valuable or changes that you feel would make Zulip a better open
@ -247,9 +248,10 @@ responsive so this usually means we missed your message.
For significant changes to the visual design, user experience, data For significant changes to the visual design, user experience, data
model, or architecture, we highly recommend posting a mockup, model, or architecture, we highly recommend posting a mockup,
screenshot, or description of what you have in mind to zulip-devel@ to screenshot, or description of what you have in mind to the
get broad feedback before you spend too much time on implementation [#design](https://chat.zulip.org/#narrow/stream/design) stream on
details. [chat.zulip.org][czo-doc] to get broad feedback before you spend too
much time on implementation details.
Finally, before implementing a larger feature, we highly recommend Finally, before implementing a larger feature, we highly recommend
looking at the looking at the
@ -259,14 +261,14 @@ on ReadTheDocs.
Feedback on how to make this development process more efficient, fun, Feedback on how to make this development process more efficient, fun,
and friendly to new contributors is very welcome! Just send an email and friendly to new contributors is very welcome! Just send an email
to the Zulip Developers list with your thoughts. to the [zulip-devel](#community) list with your thoughts.
When you feel like you have completed your work on an issue, post your When you feel like you have completed your work on an issue, post your
PR to the PR to the
[#code review](https://chat.zulip.org/#narrow/stream/code.20review) [#code review](https://chat.zulip.org/#narrow/stream/code.20review)
stream on [chat.zulip.org](https://zulip.readthedocs.io/en/latest/chat-zulip-org.html). stream on [chat.zulip.org][czo-doc]. This is our lightweight process
This is our lightweight process that gives other developers the that gives other developers the opportunity to give you comments and
opportunity to give you comments and suggestions on your work. suggestions on your work.
## License ## License
@ -288,3 +290,6 @@ The software includes some works released by third parties under other
free and open source licenses. Those works are redistributed under the free and open source licenses. Those works are redistributed under the
license terms under which the works were received. For more details, license terms under which the works were received. For more details,
see the ``docs/THIRDPARTY`` file included with this distribution. see the ``docs/THIRDPARTY`` file included with this distribution.
[czo-doc]: https://zulip.readthedocs.io/en/latest/chat-zulip-org.html