Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/saritasa-nest/django-import-export-extensions/issues.

If you are reporting a bug, please include:

Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

django-import-export-extensions could always use more documentation, whether as part of the official django-import-export-extensions docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/saritasa-nest/django-import-export-extensions/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up django-import-export-extensions for local development.

Fork the django-import-export-extensions repo on GitHub.

Clone your fork locally:

git clone git@github.com:your_name_here/django-import-export-extensions.git

Setup virtual environment:

Using pyenv:

pyenv install 3.13
pyenv shell $(pyenv latest 3.13)
poetry config virtualenvs.in-project true
source .venv/bin/activate && poetry install

Using uv:

uv venv --python 3.13 --prompt django-import-export-extensions --seed
poetry config virtualenvs.in-project true
source .venv/bin/activate && poetry install

Create a branch for local development:
```
git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass linters and the tests:
```
inv pre-commit.run-hooks
```

Commit your changes and push your branch to GitHub:

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Starting test project¶

To check your changes, you can run test_project:

Set up aliases for docker hosts in /etc/hosts:
```
inv ci.prepare
```

or specify values required for database and redis in the .env file. Example:

DB_HOST=localhost
REDIS_HOST=localhost

Run the project and go to localhost:8000 page in browser to check whether it was started:
```
inv django.run
```

Note

To run import/export in background, change CELERY_TASK_ALWAYS_EAGER to False and start celery with:

inv celery.run

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
The pull request should work for each supported Python version, and for PyPy. Check github actions status, verify that all checks have been passed.