Django Google SSO Development

Guidelines for contributing to the django-google-sso library, which adds Google Authentication to Django Admin.

Code Style & Formatting

Follow these standards when writing code:

1. **Indentation**: Use four spaces (never tabs)

2. **PEP 8 Compliance**: Follow all PEP 8 guidelines

3. **Line Length**: 92 characters (unless overridden in pyproject.toml)

4. **Formatting**: Run `pre-commit run --all` before committing

5. **Code Formatter**: Use `black` for automatic formatting

Type Hints

Always use type annotations:

Add type hints to all function signatures

Use `TypedDict` for dictionary structures

Use `dataclasses` for object definitions

Use `Enum` for fixed value sets (or `Literal` for single values)

Use `|` for optional types (e.g., `str | None`)

String Conventions

Use **f-strings** for string formatting

Use **double quotes** for regular strings

Use **triple quotes** for multi-line strings

Comments & Documentation

Write comments to explain complex logic

Add **Google-style docstrings** to functions/classes with more than 7 lines

Always write in **English** (code, comments, docs, commits, tests)

For non-English content, create separate files and use `gettext` for translation

Testing

Use pytest with these practices:

Write tests with `pytest`

Use `pytest.mark.parametrize` to avoid duplication

Ensure unit tests cover new features

Commit Messages

Follow semantic versioning with one-line commits:

| Prefix | Use When |

|--------|----------|

| `feat:` | New code added to both `./django_google_sso` and unit tests |

| `fix:` | Changes only to code inside `./django_google_sso` |

| `chore:` | Changes to files outside `./django_google_sso` |

| `ci:` | Changes only to `pyproject.toml` |

| `docs:` | Changes only to `./docs` or README |

| `refactor:` | Changes to `./django_google_sso` without test changes |

| `BREAKING CHANGE:` | Changes to minimum Python version in `pyproject.toml` |

Additional Guidelines

For project-specific guidelines, check the local file at `.junie/guidelines.md` in the repository.

Django Google SSO Development

Django Google SSO Development

Code Style & Formatting

Type Hints

String Conventions

Comments & Documentation

Testing

Commit Messages

Additional Guidelines

Reviews (0)