Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 3.79 KB

README.md

File metadata and controls

74 lines (52 loc) · 3.79 KB

Diaspora

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

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.

Installation instructions

Installation instructions are here.

Thanks for helping battle test Diaspora. Please report any bugs you see at bugs.joindiaspora.com.

Contributing to Diaspora

You can find an introduction to the source code here. Bugs and pending features are on our issue tracker. A step-by-step guide to development using git can be found here.

Here are a few good places to start:

  • Run "rake spec" to run our Rspec unit test suite. Here is an introduction to our Rspec convention. Take a look at the pending specs, make one pass!

  • Run "rake cucumber" to run our Cucumber 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 and pick a bug. Write a spec for it, so it's easy for another developer to fix it.

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.

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 for when to rebase.

We need you to fill out a contributor agreement form 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. We're currently working on revising it more details on what we're going for can be found here.

Resources

Here is our bug tracker and our roadmap. Also, you can find see what the core team is upto here.

Ongoing discussion:

More general info and updates about the project can be found on our blog, and on Twitter. Also, be sure to join the official mailing list.

If you wish to contact us privately about any exploits in Diaspora you may find, you can email exploits@joindiaspora.com.