contribute.md

Contribute

This project uses poetry for dependency management and packaging.

1. Install poetry from https://python-poetry.org/

2. Fork this project into your account

3. Clone the repository to you preferred location:

$ git clone https://github.com/<user>/djangocms-xliff/

4. Change into the directory:

$ cd djangocms-xliff/

5. Create a feature branch:

$ git checkout -b feature/<branch_name>

6. Install the dependencies:

$ poetry install

7. Activate the virtual environment:

$ poetry shell

8. Install pre-commit for linting, security, formatting, etc. (only needed once):

$ pre-commit install

9. This project uses tox to run against all supported python, django and django-cms versions. If you are missing a python interpreter install it on your system (or preferably use pyenv). Then make sure all tests run successfully:

$ tox

10. Optionally if you need to generate translations use the following commands:

# Generate .po files to translate in a language
django-admin makemessages --locale <language_code>

# Compile .po into .mo
django-admin compilemessages --ignore .tox

11. Create the pull request