Skip to content
Extraits de code Groupes Projets
README.md 3,42 ko
Newer Older
ilya's avatar
ilya a validé
# Diaspora

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

Raphael's avatar
Raphael a validé
**THIS IS PRE-ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.**
ilya's avatar
ilya a validé
**PLEASE, DO NOT RUN IN PRODUCTION. IT IS FUN TO GET RUNNING, BUT EXPECT THINGS
ilya's avatar
ilya a validé

ilya's avatar
ilya a validé
## Installation instructions

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

ilya's avatar
ilya a validé
Thanks for helping battle test Diaspora.
Please report any bugs you see at [bugs.joindiaspora.com](http://bugs.joindiaspora.com).
ilya's avatar
ilya a validé

Raphael's avatar
Raphael a validé
## Contributing to Diaspora
Raphael's avatar
Raphael a validé
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:
Raphael's avatar
Raphael a validé

Raphael's avatar
Raphael a validé
- 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!
Raphael's avatar
Raphael a validé

Raphael's avatar
Raphael a validé
- 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 a validé

Raphael's avatar
Raphael a validé
- 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 a validé

Raphael's avatar
Raphael a validé
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 a validé

Raphael's avatar
Raphael a validé
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 a validé

Raphael's avatar
Raphael a validé
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.
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).

## Resources

We are maintaining a
[public tracker project](http://www.pivotaltracker.com/projects/61641)
and a
[roadmap](https://github.com/diaspora/diaspora/wiki/Roadmap). Also, you can
file [bug reports](http://bugs.joindiaspora.com) on our issue tracker.

Ongoing discussion:
- [Diaspora Developer Google Group](http://groups.google.com/group/diaspora-dev)
- [Diaspora Discussion Google Group](http://groups.google.com/group/diaspora-discuss)
- [Diaspora Q&A site](http://diaspora.shapado.com/)
- [#diaspora-dev IRC channel](irc://irc.freenode.net/#diaspora-dev)
  ([join via the web client](http://webchat.freenode.net?channels=diaspora-dev))
More general info and updates about the project can be found on
[our blog](http://joindiaspora.com),
Pistos's avatar
Pistos a validé
[and on Twitter](http://twitter.com/joindiaspora).
Also, be sure to join the official [mailing list](http://eepurl.com/Vebk).
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).