Working on front-end¶
To started development fron-end part of
django-filer simply install all the packages over npm:
To compile scss to css:
To run sass watcher:
Since github issues does not support assigning an issue to a non collaborator (yet), please just add a comment on the issue to claim it.
The code should be PEP8 compliant. With the exception that the line width is not limited to 80, but to 120 characters.
The flake8 command can be very helpful (we run it as a separate env through Tox on Travis). If you want to check your changes for code style:
This runs the checks without line widths and other minor checks, it also ignores source files in the migrations and tests and some other folders.
This is the last command to run before submitting a PR (that will run tests in all tox environments):
Another useful tool is reindent. It fixes whitespace and indentation stuff:
$ reindent -n filer/models/filemodels.py
Fork -> Code -> Pull request
- fork django-filer on github
- clone your fork
git clone firstname.lastname@example.org:username/django-filer.git
- initialize git flow:
git flow init(choose all the defaults)
git flow feature start my_feature_namecreates a new branch called
- ...code... ...code... ..commit.. ..commit..
git flow feature publishcreates a new branch remotely and pushes your changes
- navigate to the feature branch on github and create a pull request to the
- after reviewing the changes may be merged into
developand then eventually into
masterfor the release.
If the feature branch is long running, it is good practice to merge in the current state of the
develop branch into the feature branch sometimes. This keeps the feature branch up to date and reduces the likeliness of merge conflicts once it is merged back into develop.