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

3
Welcome to the Diaspora project, the privacy aware, personally controlled, do-it-all, open source social
4
network. [Diaspora Project](http://diasporaproject.org)
ilya's avatar
ilya committed
5

6 7 8 9 10
************************
Diaspora is currently going through a huge refactoring push, the code is changing fast!
If you want to do something big, reach out on IRC or the mailing list first, so you can contribute effectively <3333
************************

11 12 13
**THIS IS ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.**
**IT IS FUN TO GET RUNNING, BUT EXPECT THINGS TO BE BROKEN.**

14 15
[![Build Status](https://secure.travis-ci.org/diaspora/diaspora.png)](http://travis-ci.org/diaspora/diaspora)
[![Dependency Status](https://gemnasium.com/diaspora/diaspora.png?travis)](https://gemnasium.com/diaspora/diaspora)
16 17 18 19

**TL;DR**

## Are you a user?
20
You can get an account on [many Diaspora pods](http://podupti.me), or sign up for an invite
21 22 23 24 25 26
at the pod run by the original development team at https://joindiaspora.com

## Are you a developer?

Read on for how to get started.

27 28 29 30 31
We need you to fill out a
[contributor agreement form](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ)
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
[here](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ).
32 33


34
## Installation Guides
ilya's avatar
ilya committed
35

36
We have guides for pod admins (called podmins) [here](https://github.com/diaspora/diaspora/wiki/Installation-Guides).
ilya's avatar
ilya committed
37 38


Raphael's avatar
Raphael committed
39
## Contributing to Diaspora
40

41
Information on contributing to the Diaspora project can be found on the wiki. You can check our [Issue tracker (bugs)](https://github.com/diaspora/diaspora/issues), learn how we [work with git](http://github.com/diaspora/diaspora/wiki/Git-Workflow), and [become more familiar with our system](https://github.com/diaspora/diaspora/wiki/Developers)
zhitomirskiyi's avatar
zhitomirskiyi committed
42

Raphael's avatar
Raphael committed
43 44


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

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

Raphael Sofaer's avatar
Raphael Sofaer committed
50
Catches must be tested, and all your tests should be green, 
Raphael's avatar
Raphael committed
51
unless you're marking an existing bug, before a pull request is sent.
52
Unit tests should be in Rspec, Javascript tests should be in Jasmine, and integration tests should be in Cucumber.
Raphael's avatar
Raphael committed
53

Raphael's avatar
Raphael committed
54 55
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
56

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

61

62 63
## Resources

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

68 69

Ongoing discussion:
70

71 72
- [Diaspora Developer Google Group](http://groups.google.com/group/diaspora-dev)
- [Diaspora Discussion Google Group](http://groups.google.com/group/diaspora-discuss)
73
- [#diaspora IRC channel](irc://irc.freenode.net/#diaspora)
74
  ([join via the web client](http://webchat.freenode.net?channels=diaspora))
75 76
- [#diaspora-dev IRC channel](irc://irc.freenode.net/#diaspora-dev)
  ([join via the web client](http://webchat.freenode.net?channels=diaspora-dev))
77

78
General info and updates about the project can be found on
79
[our blog](http://blog.joindiaspora.com),
80
[our devblog](http://devblog.joindiaspora.com),
Pistos's avatar
Pistos committed
81
[and on Twitter](http://twitter.com/joindiaspora).
82
Also, be sure to join the official [mailing list](http://groups.google.com/group/diaspora-dev).
83

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