gabrielfalcao/lettuce — pull request #222 by benoitbryon (2012-01-22 19:32:50+00:00)
Title: Development guidelines: sharing vision and practices

Hi,

As said in #188, I'd like to contribute to this project.
So:

* I installed a development environment for lettuce.
* I'd like to follow existing coding conventions.

To perform this, I followed existing documentation. I felt I had to think too much ;)
I mean, even if most tools are well known:

* At first, virtualenv couldn't install lxml because libxml2-dev and libxslt-dev were missing
* Then, I couldn't assert the installation procedure I followed is repeatable.
* I'm not sure about coding standards.

This pull request is a proposal to improve this:

* added a dedicated docs/dev/ where we could find every documents related to contributions.
* moved some "dev related" content from README.md to new docs/dev/ folder
* proposed conventions for documentation
* proposed a repeatable procedure to install development environment on Debian Squeeze: don't think, just execute (the document is not a script right now, but it could be). Is it compatible with the procedure you usually follow?

My motivation is to use the documentation as a start to share vision and conventions between developers:

* first-time contributions made easier
* easier code review, less support