Contributing to Django Tenant Users

Thank you for considering contributing to Django Tenant Users! This document outlines some guidelines to follow when contributing to the project.

Code of Conduct

We are committed to fostering a welcoming and inclusive community.

Getting Started

  1. Fork the repository on GitHub.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/django-tenant-users.git

  3. Install Poetry if you haven’t already:

    pip install poetry

  4. Install the project dependencies using Poetry:

    poetry install

Making Changes

  1. Checkout a new branch for your feature/bugfix:

    git checkout -b feature/your-feature-name

  2. Make your changes and ensure that the code passes all tests:

    poetry run pytest

  3. Format the code using black and isort. It’s important to run isort first and then black:

    pip install isort black

isort .
black .

  4. Format the documentation using rstfmt:

    pip install rstfmt

poetry run rstfmt docs

  5. Commit your changes with a descriptive commit message:

    git commit -am "Add feature: Your feature description"

  6. Push your branch to your forked repository:

    git push origin feature/your-feature-name

  7. Open a pull request on GitHub. Please provide a clear description of the changes you’ve made.

Code Style

We follow the PEP 8 style guide for Python code. Please ensure that your code adheres to these guidelines.

Documentation

If you’re adding a new feature, please update the documentation accordingly. Documentation changes should be made in the docs/ directory.

Tests

Ensure that your code has appropriate test coverage. Write tests for new features and ensure that existing tests pass.

Questions and Support

If you have questions or need support, feel free to open an issue on GitHub.

Thank you for contributing to Django Tenant Users!