Skip to content

Commit

Permalink
Reorder README.md to highlight contributing section earlier.
Browse files Browse the repository at this point in the history
  • Loading branch information
timabbott committed Sep 26, 2015
1 parent b59b5ca commit 3f76745
Showing 1 changed file with 34 additions and 33 deletions.
67 changes: 34 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
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/).

Please run the tests (tools/test-all) before submitting your pull
request and read our [commit message style
guidelines](http://zulip.readthedocs.org/en/latest/code-style.html#commit-messages).

Zulip has a growing collection of developer documentation including
detailed documentation on coding style available on [Read The
Docs](https://zulip.readthedocs.org/).

Zulip also has a [development discussion mailing list](https://groups.google.com/forum/#!forum/zulip-devel)

Feel free to send any questions or suggestions of areas where you'd
love to see more documentation to the list!

We recommend sending proposals for large features or refactorings to
the zulip-devel list for discussion and advice before getting too deep
into implementation.

Please report any security issues you discover to [email protected].

Running Zulip in production
===========================

This is documented in https://zulip.org/server.html and README.prod.md.

Installing the Zulip Development environment
============================================

Expand Down Expand Up @@ -115,8 +147,8 @@ individual tests, e.g.:
./tools/test-js-with-casper 10-navigation.js
```

Possible issues
===============
Possible testing issues
=======================

The Casper tests are flaky on the Virtualbox environment (probably due
to some performance-sensitive races). Until this issue is debugged,
Expand All @@ -132,37 +164,6 @@ When running the test suite, if you get an error like this:

… 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/).

Please run the tests (tools/test-all) before submitting your pull
request.

Zulip has a growing collection of developer documentation including
detailed documentation on coding style available on [Read The
Docs](https://zulip.readthedocs.org/).

Zulip also has a [development discussion mailing list](https://groups.google.com/forum/#!forum/zulip-devel)

Feel free to send any questions or suggestions of areas where you'd
love to see more documentation to the list!

We recommend sending proposals for large features or refactorings to
the zulip-devel list for discussion and advice before getting too deep
into implementation.

Please report any security issues you discover to [email protected].

Running Zulip in production
===========================

This is documented in https://zulip.org/server.html and README.prod.md.

License
=======

Expand Down

0 comments on commit 3f76745

Please sign in to comment.