diff options
author | Raphael <raphael@joindiaspora.com> | 2010-10-12 03:01:16 +0400 |
---|---|---|
committer | Raphael <raphael@joindiaspora.com> | 2010-10-12 03:01:16 +0400 |
commit | 674fbc050be44d792266232b3be147ac12cf9c4d (patch) | |
tree | 1d46c186c7449030495df437f223a2de9e34b39d /README.md | |
parent | b3d9884e0dc2527847559594aa6d24bd1d0f3546 (diff) |
Some readme modifications
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 35 |
1 files changed, 17 insertions, 18 deletions
@@ -3,37 +3,36 @@ The privacy aware, personally controlled, do-it-all, open source social network. -**DISCLAIMER: THIS IS PRE-ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.** +**THIS IS PRE-ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.** **PLEASE, DO NOT RUN IN PRODUCTION. IT IS FUN TO GET RUNNING, BUT EXPECT THINGS TO BE BROKEN** -Initial installation instructions are [here](http://github.com/diaspora/diaspora/wiki/Installing-and-Running-Diaspora). +### Installation instructions are [here](http://github.com/diaspora/diaspora/wiki/Installing-and-Running-Diaspora). -We are continuing to build features and improve the code base. -When we think it is ready for general use, we will post more final -instructions. Issue tracking is at [bugs.joindiaspora.com](bugs.joindiaspora.com). +### Please report any bugs you see. Issue tracking is at [bugs.joindiaspora.com](http://bugs.joindiaspora.com). -## Commit Guidelines +## Contributing to Diaspora -You are welcome to contribute, add to and extend Diaspora however you see fit. We -will do our best to incorporate everything that meets our guidelines. +You can find an introduction to the source code [here](http://github.com/diaspora/diaspora/wiki/An-Introduction-to-the-Diaspora-Source). +Bugs and pending features are on our [issue tracker](http://bugs.joindiaspora.com). Here are a few good places to start: +- Run "rake spec" to run our [Rspec](http://blog.davidchelimsky.net/2007/05/14/an-introduction-to-rspec-part-i/) +unit test suite. Take a look at the pending specs, make one pass! +- Run "rake cucumber" to run our [Cucumber](http://rubylearning.com/blog/2010/10/05/outside-in-development/) +integration test suite. As you can see, we need more integration tests. Pick a feature and write one! +- Take a look at the [issue tracker](http://bugs.joindiaspora.com) and pick a bug. +Write a spec for it, so it's easy for another developer to fix it. -You can find an introduction to the source code [here](http://github.com/diaspora/diaspora/wiki/An-Introduction-to-the-Diaspora-Source). For an idea of where to start, look at our [issue tracker](bugs.joindiaspora.com). +Patches must be tested, and all your tests should be green, +unless you're marking an existing bug, before a pull request is sent. +Unit tests should be in Rspec, and integration tests should be in Cucumber. -Make a topic branch. By making your changes in a topic branch, you ensure that new commits to your master are not included in the pull request, and it's easier for us to merge your commits. +Please make your changes in a branch to ensure that new commits to your master are +not included in the pull request, and to make it easier for us to merge your commits. Please do not rebase our tree into yours. See [here](http://www.mail-archive.com/dri-devel@lists.sourceforge.net/msg39091.html) for when to rebase. -Patches must be tested, and all your tests should be green -before a pull request is sent. Please write your tests in Rspec. - -GEMS: We would like to keep external dependencies unduplicated. We're using -Nokogiri, Mongomapper, and EM::HttpRequest as much as possible. We have a few -gems in the project we'd rather not use, but if you can, use dependencies we -already have. - We need you to fill out a [contributor agreement form](https://spreadsheets.google.com/a/joindiaspora.com/viewform?formkey=dGI2cHA3ZnNHLTJvbm10LUhXRTJjR0E6MQ&theme=0AX42CRMsmRFbUy1iOGYwN2U2Mi1hNWU0LTRlNjEtYWMyOC1lZmU4ODg1ODc1ODI&ifq) before we can accept your patches. The agreement gives Diaspora joint |