How to work on bugs: Difference between revisions
mNo edit summary |
(wikisyntax) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Thank you for helping us make Diaspora awesome! ;)<br /> | Thank you for helping us make Diaspora awesome! ;)<br /> | ||
If you found a bug and want to report it, [[How to report a bug|here is how to]]. If you want to start contributing by fixing a bug, this is the correct page. | |||
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. | 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. | ||
# '''Make an account on [https://github.com Github]''' | |||
#: (If you don’t already have one.) This is necessary in order to contribute the code you write. | |||
# '''Find a bug to work on''' | |||
#: One possibility is to look at the [https://github.com/diaspora/diaspora/issues 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…). | |||
# '''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. | |||
# '''Before you start''' | |||
#: Now, there are a few things we want you to keep in mind before you start to work on the bug. | |||
#* You will need to [[Installation|set up a development environment]] | |||
#* Please skim through our page on [[Git Workflow|how we use git]] so that there will be no problems merging your fix. | |||
#* You migh also be interested in an [[An Introduction to the Diaspora Source|introduction to the source code]] and the [[FAQ_for_Developers]]. | |||
#:If you need help with any of that, run into a problem or get stuck somewhere, don’t hesitate to ask, either on [https://discourse.diasporafoundation.org discourse] or come to our [[How_We_Communicate|IRC chatroom]]. | |||
# '''Write awesome code''' | |||
#: We strive to encourage ''TDD'' ([https://en.wikipedia.org/wiki/Test_Driven_Development Test Driven Development]) or ''BDD'' ([https://en.wikipedia.org/wiki/Behavior_Driven_Development 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. | |||
If you need help with any of that, run into a problem or get stuck somewhere, don’t hesitate to ask, either on | # '''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 [[Git Workflow|here]] or [http://help.github.com/send-pull-requests/ here] for specific instructions on how to do that. | |||
# '''Done''' | |||
#: ''Great! You just fixed a bug. We really can’t thank you enough for it. <3'' | |||
[[Category:Developers]] | [[Category:Developers]] | ||
[[Category:Github transfer done]] | [[Category:Github transfer done]] | ||
Latest revision as of 04:30, 16 August 2017
Thank you for helping us make Diaspora awesome! ;)
If you found a bug and want to report it, here is how to. If you want to start contributing by fixing a bug, this is the correct page.
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.
- Make an account on Github
- (If you don’t already have one.) This is necessary in order to contribute the code you write.
- 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…).
- 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.
- Before you start
- Now, there are a few things we want you to keep in mind before you start to work on the bug.
- You will need to set up a development environment
- Please skim through our page on how we use git so that there will be no problems merging your fix.
- You migh also be interested in an introduction to the source code and the FAQ_for_Developers.
- If you need help with any of that, run into a problem or get stuck somewhere, don’t hesitate to ask, either on discourse or come to our IRC chatroom.
- 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.
- Submit your fix
- Done
- Great! You just fixed a bug. We really can’t thank you enough for it. <3