summaryrefslogtreecommitdiff
path: root/_posts/2010-10-04-how-to-contribute-to-dancer.md
diff options
context:
space:
mode:
authorFranck Cuny <franck.cuny@gmail.com>2013-11-26 10:36:10 -0800
committerFranck Cuny <franck.cuny@gmail.com>2013-11-26 10:36:10 -0800
commit8ddf2e94df70707b458528a437759b96046d3e01 (patch)
treed442818d92d3c9c6f7fcdc92857a1228963849a1 /_posts/2010-10-04-how-to-contribute-to-dancer.md
parentDon't need to use the IP in the makefile. (diff)
downloadlumberjaph-8ddf2e94df70707b458528a437759b96046d3e01.tar.gz
Huge update.
Moved all posts from textile to markdown. Updated all the CSS and styles. Added a new page for the resume.
Diffstat (limited to '')
-rw-r--r--_posts/2010-10-04-how-to-contribute-to-dancer.md (renamed from _posts/2010-10-04-how-to-contribute-to-dancer.textile)28
1 files changed, 13 insertions, 15 deletions
diff --git a/_posts/2010-10-04-how-to-contribute-to-dancer.textile b/_posts/2010-10-04-how-to-contribute-to-dancer.md
index 6ddf836..b35ee30 100644
--- a/_posts/2010-10-04-how-to-contribute-to-dancer.textile
+++ b/_posts/2010-10-04-how-to-contribute-to-dancer.md
@@ -1,39 +1,37 @@
---
layout: post
-category: perl
+summary: In which I explain how to contribute to Dancer.
title: How to contribute to Dancer
---
For our development projects, we rely a lot on Github. Lately, more and more people started contributing to Dancer, but not all of them are familiar with Github or git. Here is a little step-by-step guide on how to contribute. You don't need to be a Perl expert to contribute, you can provide help by correcting documentation error, or adding a new recipe to our cookbook.
-h3. the code
+## the code
-The main repository is hosted "here":http://github.com/sukria/dancer. There are two main branches:
+The main repository is hosted [here](http://github.com/sukria/dancer). There are two main branches:
- * master
- * devel
+* master
+* devel
In the master branch we accept only bug fixes and doc fixes/updates. The current master branch will be the future 1.2 version.
The devel branch is where we add new features, or improve existing features.
-h3. contributing
+## contributing
-First, go to "github.com/sukria/dancer":http://github.com/sukria/dancer and click on the "fork" button. Now, here is a little tutorial on how to fetch the repository, list the local and remote branches, and track the remote devel branch.
+First, go to [github.com/sukria/dancer](http://github.com/sukria/dancer) and click on the "fork" button. Now, here is a little tutorial on how to fetch the repository, list the local and remote branches, and track the remote devel branch.
-<script src="http://gist.github.com/609443.js?file=forking%20dancer"></script>
+Now that you know what the purpose of each branch is, you can decide to work on master or devel (`git checkout devel` to switch branch).
-Now that you know what the purpose of each branch is, you can decide to work on master or devel (*git checkout devel* to switch branch).
+## sending your patch
-h3. sending your patch
+As I've previously stated, we rely a lot on the github features and interface. So now you've written your patch. First, be sure to provide one or more tests, and to run the test suite (with `make test` or `prove -r t/`). If all the tests pass, you can send a pull request. For this, you go on your own fork on github (http://github.com/$user/dancer), and you click on the "Pull Request" button.
-As I've previously stated, we rely a lot on the github features and interface. So now you've written your patch. First, be sure to provide one or more tests, and to run the test suite (with *make test* or *prove -r t/*). If all the tests pass, you can send a pull request. For this, you go on your own fork on github (http://github.com/$user/dancer), and you click on the "Pull Request" button.
+You can at any time see all the commits done by others that have not yet been merged into one of our branches at [this url](http://github.com/sukria/Dancer/forkqueue).
-You can at any time see all the commits done by others that have not yet been merged into one of our branches at "this url":http://github.com/sukria/Dancer/forkqueue.
+## reporting and/or fixing bugs
-h3. reporting and/or fixing bugs
-
-We prefer to use the github issue tracker instead of RT. So if you want to report a bug, go "there":http://github.com/sukria/dancer/issues.
+We prefer to use the github issue tracker instead of RT. So if you want to report a bug, go [there](http://github.com/sukria/dancer/issues).
If your commit fixes a bug reported there, please add in your commit message something like 'fixing GH #xxx" where xxx is the bug id.