Difference between revisions of "How to work on bugs"

From diaspora* project wiki
Jump to: navigation, search
m
Line 12: Line 12:
 
  Now, there are a few things we want you to keep in mind before you start to work on the bug.
 
  Now, there are a few things we want you to keep in mind before you start to work on the bug.
 
<ul>
 
<ul>
<li>You will need to [[Installation guides|set up a development environment]]</li>
+
<li>You will need to [[Installation|set up a development environment]]</li>
 
<li>Please skim through our page on [[Git Workflow|how we use git]] so that there will be no problems merging your fix.</li>
 
<li>Please skim through our page on [[Git Workflow|how we use git]] so that there will be no problems merging your fix.</li>
 
<li>You migh also be interested in an [[An Introduction to the Diaspora Source|introduction to the source code]] and the [[FAQ_for_Developers]].</li></ul>
 
<li>You migh also be interested in an [[An Introduction to the Diaspora Source|introduction to the source code]] and the [[FAQ_for_Developers]].</li></ul>

Revision as of 23:56, 19 July 2013

Thank you for helping us make Diaspora awesome! ;)
So you’d like to start contributing, but you don’t know where to begin? This is a fairly large project, which means it’s probably best to get your hands dirty with a small fix so you can get used to the codebase.

  1. Make an account on Github
    (If you don’t already have one.) This is necessary in order to contribute the code you write.
  2. Find a bug to work on
    One possibility is to look at the issues list on Github and look for bugs with the "newcomer" or "quickfix" labels. Those bugs often cover a wide selection of topics for various skillsets and interests (Ruby/Rails, HTML/CSS, JavaScript…).
  3. Claim the issue
    If you selected your bug directly from the issue tracker, just leave a note in the comments to that bug, saying you started to work on it.
  4. Before you start
    Now, there are a few things we want you to keep in mind before you start to work on the bug. If you need help with any of that, run into a problem or get stuck somewhere, don’t hesitate to ask, either on the mailing list or come to our IRC chatroom.
  5. Write awesome code
    We strive to encourage TDD (Test Driven Development) or BDD (Behaviour Driven Development) when possible. In short that means before you write some actual code, you should write a test firsts that fails because of the bug, then fix the bug, which in turn also makes the test pass.
  6. Submit your fix
    Now it’s time to push your git branch to your fork on Github and make a pull request for it. Look here or here for specific instructions on how to do that.
  7. Done
    Great! You just fixed a bug. We really can’t thank you enough for it. <3