From ac8167062ba09216c781a4932e75cb211e62e239 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Tue, 22 Sep 2015 21:43:29 -0700 Subject: [PATCH] Markdownify README files and add contribution documentation in README.md. (imported from commit aac3bc2d051dd328cb55be05fd44d77b626e1201) --- README.dev => README.md | 23 +++++++++++++++++++++-- README.prod => README.prod.md | 0 2 files changed, 21 insertions(+), 2 deletions(-) rename README.dev => README.md (83%) rename README.prod => README.prod.md (100%) diff --git a/README.dev b/README.md similarity index 83% rename from README.dev rename to README.md index c7f24c51f4..2273325034 100644 --- a/README.dev +++ b/README.md @@ -1,5 +1,5 @@ -Getting started -=============== +Installing the Zulip Development environment +============================================ Using Vagrant ------------- @@ -103,3 +103,22 @@ When running the test suite, if you get an error like this: LINE 2: ...ECT message_id, flags, subject, rendered_content, ts_match_l... ^ … then you need to install tsearch-extras, described above. Afterwards, re-run the init*-db and the do-destroy-rebuild*-database scripts. + +Contributing to Zulip +===================== + +Zulip welcomes all forms of contributions! + +Before a pull request can be merged, you need to to sign the [Dropbox +Contributor License Agreement](https://opensource.dropbox.com/cla/). + +Also, you should run the tests and lint rules to make sure that they +all pass. The development server configuration automatically sets up +`tools/lint-all` to run as a pre-commit hook. + +Zulip also has a [development discussion mailing list](https://groups.google.com/forum/#!forum/zulip-devel) + +Running Zulip in production +=========================== + +This is documented in https://zulip.org/server.html and README.prod.md. diff --git a/README.prod b/README.prod.md similarity index 100% rename from README.prod rename to README.prod.md