Contributing

​

Code of Conduct

​

Getting Started

# Fork on GitHub, then clone your fork
git clone [email protected]:your-username/bakerydemo.git
cd bakerydemo

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -r requirements/development.txt
cp bakerydemo/settings/local.py.example bakerydemo/settings/local.py
cp .env.example .env
./manage.py migrate
./manage.py load_initial_data

git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

# Run all tests
./manage.py test

# Run specific app tests
./manage.py test bakerydemo.blog

# Run with coverage
coverage run --source='.' manage.py test
coverage report

git add .
git commit -m "Add recipe search functionality

- Implement search backend for recipes
- Add search filters for ingredients
- Update tests

Closes #123"

Fix broken image upload in blog posts

The image upload was failing due to incorrect MIME type validation.
Updated the validation logic to accept all standard image formats.

Fixes #456

git push origin feature/your-feature-name

​

Development Workflow

​

For Contributors Without Write Access

1. Fork the repository
2. Create a feature branch
3. Make changes and commit
4. Push to your fork
5. Submit a pull request
6. Wait for review and address feedback

​

For Contributors With Write Access

1. Create a PR that’s not ready for review
2. Assign the work in progress label
3. When ready for review:
   • Remove work in progress label
   • Assign needs review label

• Typo fixes
• Documentation updates
• Minor style adjustments
• Dependency updates (with testing)

• New features
• Refactoring
• Breaking changes
• Significant bug fixes

​

Coding Standards

​

Python Code Style

line-length = 88
target-version = "py310"

[lint]
select = [
    "E",   # pycodestyle errors
    "W",   # pycodestyle warnings
    "F",   # pyflakes
    "I",   # isort
    "B",   # flake8-bugbear
    "C4",  # flake8-comprehensions
]

# Check for issues
ruff check .

# Auto-fix issues
ruff check --fix .

# Format code
ruff format .

​

Template Style

• djhtml for Django template formatting
• curlylint for template linting

# Format templates
djhtml bakerydemo/

# Lint templates
curlylint bakerydemo/

​

JavaScript/CSS Style

• ESLint for JavaScript linting
• Prettier for code formatting
• Stylelint for CSS linting

# Install Node dependencies
npm install

# Lint JavaScript
npm run lint:js

# Format code
npm run format

# Lint CSS
npm run lint:css

​

Pre-commit Hooks

# Install pre-commit
pip install pre-commit

# Install hooks
pre-commit install

# Run manually on all files
pre-commit run --all-files

• Format Python code with Ruff
• Format templates with djhtml
• Lint templates with curlylint
• Format JS/CSS with Prettier
• Check for common issues

​

Testing Guidelines

​

Writing Tests

from django.test import TestCase
from wagtail.test.utils import WagtailPageTestCase

class BlogPageTests(WagtailPageTestCase):
    def setUp(self):
        # Set up test data
        self.home_page = HomePage.objects.first()
        self.blog_index = BlogIndexPage(
            title="Blog",
            slug="blog",
        )
        self.home_page.add_child(instance=self.blog_index)

    def test_can_create_blog_page(self):
        # Test that blog pages can be created
        blog_page = BlogPage(
            title="Test Post",
            slug="test-post",
            introduction="Test introduction",
        )
        self.blog_index.add_child(instance=blog_page)
        self.assertTrue(blog_page.live)

    def test_blog_page_context(self):
        # Test page context
        response = self.client.get(self.blog_page.url)
        self.assertEqual(response.status_code, 200)

# Run tests with coverage
coverage run --source='.' manage.py test
coverage report
coverage html  # Generate HTML report

​

Manual Testing Checklist

• All tests pass
• Code is formatted with Ruff
• No linting errors
• Changes work in multiple browsers (if UI changes)
• Changes work with demo data
• Documentation updated (if needed)
• Migration files included (if model changes)

​

Documentation

​

When to Update Documentation

• Adding new features
• Changing existing behavior
• Adding management commands
• Updating dependencies
• Fixing significant bugs

​

Documentation Style

• Use clear, concise language
• Include code examples
• Add screenshots for UI changes
• Keep README.md up to date
• Update inline code comments

​

Issue Tracking

​

Reporting Bugs

1. Description: Clear description of the issue
2. Steps to reproduce:
   1. Go to /admin/pages/
   2. Click 'Add child page'
   3. Select 'Blog page'
   4. See error
   
3. Expected behavior: What should happen
4. Actual behavior: What actually happens
5. Environment:
   • OS: macOS 13.0
   • Python: 3.11
   • Django: 6.0
   • Wagtail: 7.2
6. Screenshots: If applicable
7. Error logs: Full traceback if available

​

Feature Requests

1. Use case: Why is this needed?
2. Proposed solution: How should it work?
3. Alternatives: Other approaches considered?
4. Examples: Similar features in other projects?

​

Pull Request Guidelines

​

PR Description Template

## Description
Brief description of changes

## Related Issue
Closes #123

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Testing
- [ ] All tests pass
- [ ] New tests added
- [ ] Manual testing completed

## Screenshots
(if applicable)

## Checklist
- [ ] Code follows project style guidelines
- [ ] Self-review completed
- [ ] Comments added for complex code
- [ ] Documentation updated
- [ ] No new warnings generated

​

Review Process

# Make changes
git add .
git commit -m "Address review feedback"
git push origin feature/your-feature

​

Commit Message Guidelines

​

Cross-Reference Issues

# Close single issue
git commit -m "Fix broken image upload

Fixes #123"

# Close multiple issues
git commit -m "Add recipe search

Closes #45, closes #67, fixes #89"

# Reference without closing
git commit -m "Update search tests

Related to #123"

• close, closes, closed
• fix, fixes, fixed
• resolve, resolves, resolved

​

Preparing Fixture Data

./manage.py dumpdata --natural-foreign --indent 2 \
  -e auth.permission \
  -e contenttypes \
  -e wagtailcore.GroupCollectionPermission \
  -e wagtailimages.rendition \
  -e sessions \
  -e wagtailsearch.indexentry \
  -e wagtailsearch.sqliteftsindexentry \
  -e wagtailcore.referenceindex \
  -e wagtailcore.pagesubscription \
  -e wagtailcore.workflowcontenttype \
  -e wagtailadmin.editingsession \
  > bakerydemo/base/fixtures/bakerydemo.json

npx prettier --write bakerydemo/base/fixtures/bakerydemo.json

​

Getting Help

​

Community Resources

​

Maintainer Contact

• Open a GitHub issue
• Contact maintainers on Slack
• Email security issues to [email protected]

​

Recognition

• GitHub contributors list
• Release notes (for significant contributions)
• Project documentation (where appropriate)