README.md 4.36 KB
Newer Older
ilya's avatar
ilya committed
1
# Diaspora
2
[![Build Status](https://secure.travis-ci.org/diaspora/diaspora.png)](http://travis-ci.org/diaspora/diaspora)
ilya's avatar
ilya committed
3 4 5 6

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

7 8 9 10 11 12 13 14 15 16 17

**TL;DR**

## Are you a user?
You can get an account on any Diaspora pod(http://podup.sargodarya.de or http://dspr.tk/a for a list of pods), or sign up for an invite
at the pod run by the original development team at https://joindiaspora.com

## Are you a developer?

Read on for how to get started.

Raphael Sofaer's avatar
Raphael Sofaer committed
18 19
**THIS IS ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.**
**IT IS FUN TO GET RUNNING, BUT EXPECT THINGS TO BE BROKEN.**
ilya's avatar
ilya committed
20

Daniel Grippi's avatar
Daniel Grippi committed
21 22
## Want an invite?

23
Diaspora is decentralized. You don't need an invite to joindiaspora.com to fully participate. Just choose your pod for example at http://podup.sargodarya.de or http://dspr.tk/a If you still want one have a look at https://github.com/diaspora/diaspora/wiki/Invitations Or setup your own pod 
Daniel Grippi's avatar
Daniel Grippi committed
24 25 26 27

Even if you're not a programmer, we'd love for you to give Diaspora a spin; all suggestions and comments welcome!


ilya's avatar
ilya committed
28 29
## Installation instructions

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

ilya's avatar
ilya committed
32
Thanks for helping battle test Diaspora.
33
Please report any bugs you see at [GitHub Issues](https://github.com/diaspora/diaspora/issues).
ilya's avatar
ilya committed
34

Raphael's avatar
Raphael committed
35
## Contributing to Diaspora
36

37
###[An introduction to the source code](http://github.com/diaspora/diaspora/wiki/An-Introduction-to-the-Diaspora-Source)
38
###[Issue tracker (bugs and features)](https://github.com/diaspora/diaspora/issues)
39
###[How to use git](http://github.com/diaspora/diaspora/wiki/Git-Workflow)
zhitomirskiyi's avatar
zhitomirskiyi committed
40 41

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

Raphael's avatar
Raphael committed
43
- Run "rake spec" to run our [Rspec](http://blog.davidchelimsky.net/2007/05/14/an-introduction-to-rspec-part-i/) 
44
unit test suite.
Raphael's avatar
Raphael committed
45

Raphael's avatar
Raphael committed
46
- Run "rake cucumber" to run our [Cucumber](http://rubylearning.com/blog/2010/10/05/outside-in-development/)
Raphael Sofaer's avatar
Raphael Sofaer committed
47
integration test suite.
Raphael's avatar
Raphael committed
48

49
- Take a look at the [issue tracker](https://github.com/diaspora/diaspora/issues) and pick a bug.
Raphael's avatar
Raphael committed
50
Write a spec for it, so it's easy for another developer to fix it.
Raphael's avatar
Raphael committed
51

Raphael Sofaer's avatar
Raphael Sofaer committed
52
Catches must be tested, and all your tests should be green, 
Raphael's avatar
Raphael committed
53 54
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
55

Raphael's avatar
Raphael committed
56 57
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
58

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

63
We need you to fill out a
64
[contributor agreement form](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ)
65 66
before we can accept your patches.  This dual license agreement allows
us to release limited pieces of Diaspora under the MIT license.  You can find it
67
[here](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ).
68

69 70
## Resources

71
Here is our [bug tracker](https://github.com/diaspora/diaspora/issues) and our
72
[roadmap](https://github.com/diaspora/diaspora/wiki/Roadmap). Also, you can
Raphael Sofaer's avatar
Raphael Sofaer committed
73
find see what the core team is up to [here](http://www.pivotaltracker.com/projects/61641).
zhitomirskiyi's avatar
zhitomirskiyi committed
74

75 76

Ongoing discussion:
77

78 79
- [Diaspora Developer Google Group](http://groups.google.com/group/diaspora-dev)
- [Diaspora Discussion Google Group](http://groups.google.com/group/diaspora-discuss)
80
- [Diaspora Q&A site](http://diaspora.shapado.com/)
81
- [Diasproa on Get Satisfaction](http://getsatisfaction.com/diaspora/)
82
- [#diaspora IRC channel](irc://irc.freenode.net/#diaspora)
MrZYX's avatar
MrZYX committed
83
  ([join via the web client](http://webchat.freenode.net?channels=diaspora))
84 85
- [#diaspora-dev IRC channel](irc://irc.freenode.net/#diaspora-dev)
  ([join via the web client](http://webchat.freenode.net?channels=diaspora-dev))
86

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

92 93
If you wish to contact us privately about any exploits in Diaspora you may
find, you can email
94
[exploits@joindiaspora.com](mailto:exploits@joindiaspora.com), [corresponding public key (keyID: 77485064)](http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=0xCC6CAED977485064).