Getting started with contributing: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Languages}} | |||
A lot of new contributors that want to dive in to helping fix bugs and develop new awesome things often ask "Well, where do I start?". Below are some links to comprehensive resources so that newcomers can get up to speed and get dive right in to fixing bugs. | A lot of new contributors that want to dive in to helping fix bugs and develop new awesome things often ask "Well, where do I start?". Below are some links to comprehensive resources so that newcomers can get up to speed and get dive right in to fixing bugs. | ||
== Getting started with git and GitHub == | |||
All of Diaspora's code is hosted on [http://github.com/diaspora/diaspora GitHub], a social coding platform that leverages [http://en.wikipedia.org/git Git] for many different Free and Open Source projects. You can use any operating system to contribute with GitHub, all you need is an account and to follow GitHub's easy and helpful [http://help.github.com/linux-set-up-git/ guide] for setting up your account from the command line and learning to use the commands. Git is supported on all major platforms. | All of Diaspora's code is hosted on [http://github.com/diaspora/diaspora GitHub], a social coding platform that leverages [http://en.wikipedia.org/git Git] for many different Free and Open Source projects. You can use any operating system to contribute with GitHub, all you need is an account and to follow GitHub's easy and helpful [http://help.github.com/linux-set-up-git/ guide] for setting up your account from the command line and learning to use the commands. Git is supported on all major platforms. | ||
| Line 8: | Line 8: | ||
Once you're all set up, check out the [https://github.com/diaspora/diaspora/issues issue tracker] and watch for entries tagged with "''[https://github.com/diaspora/diaspora/issues?labels=newcomer newcomer]''" or "''[https://github.com/diaspora/diaspora/issues?labels=quickfix quickfix]''". Most often those are the things which you don't need a deep understanding of the complete codebase for to work on them, and the tasks should be easy enough for novice programmers to tackle. | Once you're all set up, check out the [https://github.com/diaspora/diaspora/issues issue tracker] and watch for entries tagged with "''[https://github.com/diaspora/diaspora/issues?labels=newcomer newcomer]''" or "''[https://github.com/diaspora/diaspora/issues?labels=quickfix quickfix]''". Most often those are the things which you don't need a deep understanding of the complete codebase for to work on them, and the tasks should be easy enough for novice programmers to tackle. | ||
== All about bugs == | |||
There are some different things about bugs that you ought to know, specifically, [[How_to_Report_a_Bug|how to report a bug]], and [[How_to_work_on_bugs|how to claim and fix a bug]]. Both incorporate well into our GitHub-based workflow, and is designed to make the process of fixing bugs easier for everybody. | There are some different things about bugs that you ought to know, specifically, [[How_to_Report_a_Bug|how to report a bug]], and [[How_to_work_on_bugs|how to claim and fix a bug]]. Both incorporate well into our GitHub-based workflow, and is designed to make the process of fixing bugs easier for everybody. | ||
== How to contribute the right way == | |||
Diaspora's development tries its very best to stick to a set of guidelines when it comes to contributing code. When you're writing a bugfix or custom code from scratch, it's good practice to ask yourself: | Diaspora's development tries its very best to stick to a set of guidelines when it comes to contributing code. When you're writing a bugfix or custom code from scratch, it's good practice to ask yourself: | ||
| Line 19: | Line 19: | ||
* Am I sticking to the [[Git Workflow]] the best I can? | * Am I sticking to the [[Git Workflow]] the best I can? | ||
== Other helpful resources == | |||
Below are some helpful relevant links to other parts of the wiki. We're currently restructuring everything, so the below links may be subject to change. | Below are some helpful relevant links to other parts of the wiki. We're currently restructuring everything, so the below links may be subject to change. | ||
* [[ | * [[Required Gems Overview|An Overview of Required Ruby Gems]] | ||
* [[Installation|How to get a dev environment set up]] | * [[Installation|How to get a dev environment set up]] | ||
* [[ | * [[An Introduction to the Diaspora Source|A Detailed Introduction to the Source Code]] | ||
[[Category:Developers]] | [[Category:Developers]] | ||
[[Category:Github transfer done]] | [[Category:Github transfer done]] | ||
Revision as of 10:33, 25 November 2013
Template:Languages A lot of new contributors that want to dive in to helping fix bugs and develop new awesome things often ask "Well, where do I start?". Below are some links to comprehensive resources so that newcomers can get up to speed and get dive right in to fixing bugs.
Getting started with git and GitHub
All of Diaspora's code is hosted on GitHub, a social coding platform that leverages Git for many different Free and Open Source projects. You can use any operating system to contribute with GitHub, all you need is an account and to follow GitHub's easy and helpful guide for setting up your account from the command line and learning to use the commands. Git is supported on all major platforms.
Once you're all set up, check out the issue tracker and watch for entries tagged with "newcomer" or "quickfix". Most often those are the things which you don't need a deep understanding of the complete codebase for to work on them, and the tasks should be easy enough for novice programmers to tackle.
All about bugs
There are some different things about bugs that you ought to know, specifically, how to report a bug, and how to claim and fix a bug. Both incorporate well into our GitHub-based workflow, and is designed to make the process of fixing bugs easier for everybody.
How to contribute the right way
Diaspora's development tries its very best to stick to a set of guidelines when it comes to contributing code. When you're writing a bugfix or custom code from scratch, it's good practice to ask yourself:
- Does my code have tests?
- Am I sticking to the Git Workflow the best I can?
Other helpful resources
Below are some helpful relevant links to other parts of the wiki. We're currently restructuring everything, so the below links may be subject to change.