From 6d593eae50c36eb0d0841bb2c272a4e82b9de53d Mon Sep 17 00:00:00 2001 From: Klaus Silveira Date: Fri, 6 Jul 2012 10:23:23 -0300 Subject: [PATCH] Creating a small guide for developers interested in contributing to GitList --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 8df5c13..37949a0 100644 --- a/README.md +++ b/README.md @@ -75,5 +75,12 @@ php composer.phar install If you have Composer in your path, things get easier. But you know the drill. +## Contributing +If you are a developer, we need your help. GitList is a young project and we have lot's of stuff to do. Some developers are contributing with new features, others with bug fixes. But you can also dedicate yourself to refactoring the current codebase and improving what we already have. This is very important, we want GitList to be a state-of-the-art application, and we need your help for that. + +* Stay tuned to possible bugs, suboptimal code, duplicated code, overcomplicated expressions and unused code with [PHPMD](http://ci.gitlist.org:8080/job/GitList%20(master)/9/pmdResult/?) in our CI server +* Try to fix any [violations](http://ci.gitlist.org:8080/job/GitList%20(master)/violations/) reported +* Improve the [test coverage](http://ci.gitlist.org:8080/job/GitList%20(master)/9/cloverphp-report/) by creating unit and functional tests + ## Further information If you want to know more about customizing GitList, check the [Customization](https://github.com/klaussilveira/gitlist/wiki/Customizing) page on the wiki. Also, if you're having problems with GitList, check the [Troubleshooting](https://github.com/klaussilveira/gitlist/wiki/Troubleshooting) page. Don't forget to report issues and suggest new features! :)