Skip to content

Conversation

@miriam-z
Copy link
Contributor

Description

This PR fixes Makefile syntax errors that were preventing proper execution with .ONESHELL mode, updates the Python version to match the Dockerfile, and improves the README with comprehensive setup instructions.

Changes include:

  • Fixed bash syntax in _install-dependencies and _test targets with proper line continuations and semicolons
  • Updated .tool-versions to use Python 3.13.7 (matching Dockerfile)
  • Added setup prerequisites (asdf) and environment configuration steps to README
  • Documented the .env.example copy step and database migration requirement

Context

The Makefile targets were failing with "syntax error: unexpected end of file" because the bash commands weren't properly formatted for Make's .ONESHELL mode. This blocked developers from running make config and
make test successfully.

Additionally, the README was missing critical setup steps that new developers would need, including:

  • How to configure asdf and install dependencies
  • The requirement to copy .env.example to .env
  • Running database migrations after starting the app

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I am familiar with the contributing guidelines
  • I have followed the code style of the project
  • I have added tests to cover my changes (N/A - documentation and build script fixes)
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable
Data)
or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain
any sensitive information. We really appreciate your cooperation in this matter.

  • I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

@miriam-z miriam-z self-assigned this Oct 20, 2025
@miriam-z miriam-z added bug Something isn't working documentation Improvements or additions to documentation labels Oct 20, 2025
README.md Outdated
make dev-run
```

After starting the application, apply the database migrations:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because migrations run through docker compose running make dev-migrate will bring up the postgres container and run the migrations from the web container which means you don't need to start the application first. The docker compose file just habdles the stack for you so theres no interdependency there :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I will make this edit.

Copy link
Contributor

@Themitchell Themitchell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good bar the small comment re starting the app before running migrations

@miriam-z miriam-z closed this Oct 21, 2025
@miriam-z miriam-z reopened this Oct 21, 2025
@Themitchell Themitchell reopened this Oct 21, 2025
@Themitchell Themitchell merged commit 1717a39 into main Oct 21, 2025
45 checks passed
@Themitchell Themitchell deleted the fix/config-update branch October 21, 2025 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants