This section describes how to develop LFS.
This is only for development. Don’t use this version in production. We might break the head, add stuff which need database migrations or introduce some security issues, etc.
Creating a Development Environment¶
There is an installer based on zc.buildout, which should make the installation straightforward:
- $ git clone https://github.com/diefenbach/lfs-buildout-development.git
- $ cd lfs-buildout-development
- $ python bootstrap.py
- $ bin/buildout -v
- $ bin/django syncdb
- $ bin/django migrate
- $ bin/django lfs_init
- $ bin/django test lfs.core
- $ bin/django runserver
- Browse to http://localhost:8000
You might want to fork LFS on GitHub and point to it within buildout.cfg first.
Contributing Code to the Core¶
If you consider to contribute code to LFS, please read the following statements first:
First of all, you are very welcome!
Fork LFS GitHub and send us pull requests.
Please make sure that you just add related code to your fork. This makes it easier to review and pull your code.
$ pep8 --repeat --ignore=E501 /path/to/lfs
Every new feature must have unit tests and documentation.
All tests must pass. Please check this with:
$ bin/django test lfs.core
New features shouldn’t make LFS slower. Please see Benchmarking LFS.
Add yourself to CREDITS.txt.