README.md 3.93 KB
Newer Older
ilya's avatar
ilya committed
1 2 3 4 5
# Diaspora

The privacy aware, personally controlled, do-it-all, open source social
network.

Raphael's avatar
Raphael committed
6
**THIS IS PRE-ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.**
ilya's avatar
ilya committed
7
**PLEASE, DO NOT RUN IN PRODUCTION. IT IS FUN TO GET RUNNING, BUT EXPECT THINGS
8
TO BE BROKEN.**
ilya's avatar
ilya committed
9

ilya's avatar
ilya committed
10 11
## Installation instructions

Raphael's avatar
Raphael committed
12
Installation instructions are [here](http://github.com/diaspora/diaspora/wiki/Installing-and-Running-Diaspora).
ilya's avatar
ilya committed
13

ilya's avatar
ilya committed
14 15
Thanks for helping battle test Diaspora.
Please report any bugs you see at [bugs.joindiaspora.com](http://bugs.joindiaspora.com).
ilya's avatar
ilya committed
16

Raphael's avatar
Raphael committed
17
## Contributing to Diaspora
18

Raphael's avatar
Raphael committed
19
You can find an introduction to the source code [here](http://github.com/diaspora/diaspora/wiki/An-Introduction-to-the-Diaspora-Source).
zhitomirskiyi's avatar
zhitomirskiyi committed
20 21 22 23
Bugs and pending features are on our [issue tracker](http://bugs.joindiaspora.com). 
A step-by-step guide to development using git can be found [here](http://github.com/diaspora/diaspora/wiki/Git-Workflow).

Here are a few good places to start:
Raphael's avatar
Raphael committed
24

Raphael's avatar
Raphael committed
25
- Run "rake spec" to run our [Rspec](http://blog.davidchelimsky.net/2007/05/14/an-introduction-to-rspec-part-i/) 
ilya's avatar
ilya committed
26
unit test suite. [Here](http://github.com/diaspora/diaspora/wiki/Introduction-to-Our-Rspec-Convention) is an introduction to our Rspec convention.  Take a look at the pending specs, make one pass!
Raphael's avatar
Raphael committed
27

Raphael's avatar
Raphael committed
28 29
- 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!
Raphael's avatar
Raphael committed
30

Raphael's avatar
Raphael committed
31 32
- 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.
Raphael's avatar
Raphael committed
33

Raphael's avatar
Raphael committed
34 35 36
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.
Raphael's avatar
Raphael committed
37

Raphael's avatar
Raphael committed
38 39
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.
Raphael's avatar
Raphael committed
40

Raphael's avatar
Raphael committed
41
Please do not rebase our tree into yours.
42 43
See [here](http://www.mail-archive.com/dri-devel@lists.sourceforge.net/msg39091.html)
for when to rebase.
Raphael's avatar
Raphael committed
44

45 46 47 48 49
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
ownership of the patch so the copyright isn't scattered.  You can find it
[here](https://spreadsheets.google.com/a/joindiaspora.com/viewform?formkey=dGI2cHA3ZnNHLTJvbm10LUhXRTJjR0E6MQ&theme=0AX42CRMsmRFbUy1iOGYwN2U2Mi1hNWU0LTRlNjEtYWMyOC1lZmU4ODg1ODc1ODI&ifq).
50
We're currently working on revising it more details on what we're going for can be found [here](http://blog.joindiaspora.com/licensing.html).
51

52 53
## Resources

zhitomirskiyi's avatar
zhitomirskiyi committed
54
Here is our [bug tracker](http://bugs.joindiaspora.com) and our
55
[roadmap](https://github.com/diaspora/diaspora/wiki/Roadmap). Also, you can
zhitomirskiyi's avatar
zhitomirskiyi committed
56 57
find see what the core team is upto [here](http://www.pivotaltracker.com/projects/61641).

58 59

Ongoing discussion:
60

61 62
- [Diaspora Developer Google Group](http://groups.google.com/group/diaspora-dev)
- [Diaspora Discussion Google Group](http://groups.google.com/group/diaspora-discuss)
63
- [Diaspora Q&A site](http://diaspora.shapado.com/)
64
- [#diaspora IRC channel](irc://irc.freenode.net/#diaspora)
MrZYX's avatar
MrZYX committed
65
  ([join via the web client](http://webchat.freenode.net?channels=diaspora))
66 67
- [#diaspora-dev IRC channel](irc://irc.freenode.net/#diaspora-dev)
  ([join via the web client](http://webchat.freenode.net?channels=diaspora-dev))
68

69
More general info and updates about the project can be found on
70
[our blog](http://blog.joindiaspora.com),
Pistos's avatar
Pistos committed
71
[and on Twitter](http://twitter.com/joindiaspora).
72
Also, be sure to join the official [mailing list](http://eepurl.com/Vebk).
73

74 75 76
If you wish to contact us privately about any exploits in Diaspora you may
find, you can email
[exploits@joindiaspora.com](mailto:exploits@joindiaspora.com).