Getting started with contributing: Difference between revisions
(fixing ttiles) |
m (fixing links) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
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 GitHub=== | ===Getting started with GitHub=== | ||
All of Diaspora's code is hosted on [ | All of Diaspora's code is hosted on [http://github.com 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 About Bugs=== | ===All About Bugs=== | ||
There are some different things about bugs that you ought to know, specifically, how to [ | There are some different things about bugs that you ought to know, specifically, how to [https://github.com/diaspora/diaspora/wiki/Report-a-bug report a bug], and [https://github.com/diaspora/diaspora/wiki/Work-on-a-bug 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=== | ===How to Contribute the Right Way=== | ||
| Line 13: | Line 14: | ||
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: | ||
* Does my code have [ | * Does my code have [https://github.com/diaspora/diaspora/wiki/Testing-workflow tests]? | ||
* Am I sticking to the [ | * Am I sticking to the [https://github.com/diaspora/diaspora/wiki/Git-Workflow Git Workflow]the best I can? | ||
=== Other helpful resources === | === Other helpful resources === | ||
| Line 20: | Line 21: | ||
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. | ||
* [ | * [https://github.com/diaspora/diaspora/wiki/Merging-Pull-Requests How to work with Pull Requests] | ||
* [ | * [https://github.com/diaspora/diaspora/wiki/Overview-of-required-gems An Overview of Required Ruby Gems] | ||
* [ | * [https://github.com/diaspora/diaspora/wiki/Installing-and-Running-Diaspora How to get a dev environment set up] | ||
* [https://github.com/diaspora/diaspora/wiki/Report-a-bug How to Report a Bug] | |||
* [ | * [https://github.com/diaspora/diaspora/wiki/An-Introduction-to-the-Diaspora-Source A Detailed Introduction to the Source Code] | ||
[[Category:Developers]] | [[Category:Developers]] | ||
Revision as of 13:37, 14 November 2012
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 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.
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 Workflowthe 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.