FAQ for developers
We've started adding questions that we see a lot to this page, but it doesn't cover everything. If you have other questions, the best way to get an answer quickly is to visit us in IRC (Internet Relay Chat). IRC is a large decentralized chat network that predates the World Wide Web. The bulk of the first wave of open source software (read: Linux) was developed using IRC as a communication channel. This continues to be the case today.
If you are new to open source development, IRC works like subscription services such as Campfire and Slack, which are like fancy front ends for IRC. Links to IRC channels and mailing lists are at the bottom of this page.
- 1 How do I get the latest source?
- 2 How do I reset the database to a totally clean state?
- 3 How do I get debug information?
- 4 I have found an issue with federation, how can I debug it?
- 5 What tools will I need to do development?
- 6 Styleguides
- 7 What if my question isn't answered here?
- 8 FAQ for web developers
How do I get the latest source?
Pull the latest from github.
Install any updates to gems:
How do I reset the database to a totally clean state?
bin/rake db:drop db:create db:schema:load
How do I get debug information?
You can use the command
tail -f log/development.log
to watch the log in development mode.
I have found an issue with federation, how can I debug it?
We actually provide a special configuration for testing server-to-server communication, which produces logs that contain only the events around federation. It involves spinning up two Diaspora* instances which you can use to recreate realistic circumstances and the logs of both sides are recorded into a single file. See Federation Logger
What tools will I need to do development?
For developers who have contributed to a diaspora* project owned repository with at least two successfully merged pull requests, you can request an open source project license for RubyMine courtesy of JetBrains. Send your request for the license key - make sure to include details so that your contributions can be verified from commits. The license is valid for a year at a time. 'Note!' A limited amount of keys are available, check here to see if keys are free before requesting one.
If you use RubyMine, make sure to install the RuboCop plugin which will help you a lot to get the code styling right before pushing as a pull request.
Please keep in mind that the codebase hasn't been ported to the new style guide. So if you touch some older code while contributing, please make sure to bring it in check with our style guides.
What if my question isn't answered here?
IRC is the best way to get an answer quickly. Click the link to the join the channel in a new browser window. You can also download and use an IRC client such as Colloquy for OS X, XChat for GNU/Linux or mIRC for Windows.
- #diaspora on irc.freenode.net - general discussion and help for folks installing Diaspora
- #diaspora-dev on irc.freenode.net - discussion of the source code and help for new developer contributors
- #diaspora-de on irc.freenode.net - discussion in German.
We have two mailing lists, both Google groups. They tend to have a slightly different audience than the IRC channels, so if you can't get your question answered in IRC, you can try here.
- Discussion list - Google group for discussion of non-technical topics
- Development discussion list - Google group for discussion of installation, source code, and other technical topics
FAQ for web developers
If you're developing an external web site, and would like to know about adding diaspora related features to your site, you might want to look at the FAQ for web developers.