From 89a15e67de6d261aab0b176c699ce349dc4c3435 Mon Sep 17 00:00:00 2001 From: Greg Price Date: Wed, 7 Jun 2017 13:30:43 -0700 Subject: [PATCH] README: Harmonize references to development list and chat. Also update one reference to the list to instead point to a chat stream. --- README.md | 63 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 34 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index a701ad82be..d8db99cfbd 100644 --- a/README.md +++ b/README.md @@ -26,23 +26,24 @@ at . There are several places online where folks discuss Zulip. * 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 [a mailing list](https://groups.google.com/forum/#!forum/zulip-gsoc) 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 -[a public mailing list](https://groups.google.com/forum/#!forum/zulip-devel) -that is currently pretty low traffic because most discussions happen -in our public Zulip instance. We use it to announce Zulip developer -community gatherings and ask for feedback on major technical or design -decisions. It has several hundred subscribers, so you can use it to -ask questions about features or possible bugs, but please don't use it -ask for generic help getting started as a contributor (e.g. because -you want to do Google Summer of Code). The rest of this page covers -how to get involved in the Zulip project in detail. +* We have a [public development discussion mailing list][zulip-devel], +zulip-devel, which is currently pretty low traffic because most +discussions happen in our public Zulip instance. We use it to +announce Zulip developer community gatherings and ask for feedback on +major technical or design decisions. It has several hundred +subscribers, so you can use it to ask questions about features or +possible bugs, but please don't use it ask for generic help getting +started as a contributor (e.g. because you want to do Google Summer of +Code). The rest of this page covers how to get involved in the Zulip +project in detail. * Zulip also has a [blog](https://blog.zulip.org/) and [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]. +[zulip-devel]: https://groups.google.com/forum/#!forum/zulip-devel + ## Installing the Zulip Development environment 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 other out. Check out [#code review][code-review] on -[chat.zulip.org](https://zulip.readthedocs.io/en/latest/chat-zulip-org.html) -to help review PRs and give comments on other people's work. Everyone is -welcome to participate, even those new to Zulip! Even just checking out -the code, manually testing it, and posting on whether or not it worked -is valuable. +[chat.zulip.org][czo-doc] to help review PRs and give comments on +other people's work. Everyone is welcome to participate, even those +new to Zulip! Even just checking out the code, manually testing it, +and posting on whether or not it worked is valuable. [cla]: https://opensource.dropbox.com/cla/ [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 your changes -- the Zulip maintainers are excited to answer questions to help you stay unblocked and working efficiently. It's great to ask -questions in comments on GitHub issues and pull requests, or [on -chat.zulip.org](https://zulip.readthedocs.io/en/latest/chat-zulip-org.html). We'll -direct longer discussions to Zulip chat, but please post a summary of -what you learned from the chat, or link to the conversation, in a -comment on the GitHub issue. +questions in comments on GitHub issues and pull requests, or +[on chat.zulip.org][czo-doc]. We'll direct longer discussions to +Zulip chat, but please post a summary of what you learned from the +chat, or link to the conversation, in a comment on the GitHub issue. We also welcome suggestions of features that you feel would be 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 model, or architecture, we highly recommend posting a mockup, -screenshot, or description of what you have in mind to zulip-devel@ to -get broad feedback before you spend too much time on implementation -details. +screenshot, or description of what you have in mind to the +[#design](https://chat.zulip.org/#narrow/stream/design) stream on +[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 looking at the @@ -259,14 +261,14 @@ on ReadTheDocs. Feedback on how to make this development process more efficient, fun, 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 PR to the [#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). -This is our lightweight process that gives other developers the -opportunity to give you comments and suggestions on your work. +stream on [chat.zulip.org][czo-doc]. This is our lightweight process +that gives other developers the opportunity to give you comments and +suggestions on your work. ## 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 license terms under which the works were received. For more details, see the ``docs/THIRDPARTY`` file included with this distribution. + + +[czo-doc]: https://zulip.readthedocs.io/en/latest/chat-zulip-org.html