Skip to content

Conversation

@Andreas-Garcia
Copy link
Member

Summary

  • Align GitHub metadata and templates to DB Postgres (this repo)
  • Replace API/Django-specific templates and labels with Docker/Postgres-focused ones
  • Move canonical PR template into .github/pr_descriptions and document usage

Description

These changes adapt the repository's GitHub metadata (labeler rules, PR/issue templates, discussion templates) to the current repository's scope: a Dockerized PostgreSQL image. The prior templates and labels were tailored to the Bodzify API/Django project — this PR reworks them to be relevant to the DB image and to keep a small library of templates in .github/pr_descriptions/.

Related Issue

Type of change

  • 📚 Documentation update
  • 🔧 Configuration change (labeler, templates, CI guidance)
  • ⚠️ Breaking change

Target branch

  • main (hotfixes only)
  • develop (features, fixes, and routine work)

Changes made

  • Updated: .github/labeler.yml to match DB/Postgres project paths and type labels
  • Updated: .github/ISSUE_TEMPLATE/* (bug_report, feature_request, engineering_feature) to Docker/Postgres context
  • Added: .github/DISCUSSIONS/* templates adapted for DB/Postgres topics
  • Added: .github/pr_descriptions/pull_request_template.md (canonical PR template)
  • Updated: .gitignore to allow tracking canonical templates and ignore drafts

Testing

Recommended local checks

# Validate YAML files
yamllint .github/labeler.yml
yamllint .github/ISSUE_TEMPLATE/*.yml

# Build image for smoke test
docker build -t bodzify-db-postgres:pr .

# Run a container and check logs
docker run --rm -d --name bodzify-db-pr -e POSTGRES_PASSWORD=test -p 5432:5432 bodzify-db-postgres:pr
docker logs -f bodzify-db-pr

# Optional: verify Postgres reachable from host
docker run --rm --network host postgres:16.4 psql -h localhost -U postgres -c '\l'

docker stop bodzify-db-pr || true

Optional checks

  • Dockerfile linting: hadolint Dockerfile
  • Security scan: trivy image --severity HIGH,CRITICAL bodzify-db-postgres:pr
  • GitHub issue/PR preview: open a draft PR and check template and label behavior

Checklist

  • README/CHANGELOG updated (if applicable)
  • Labels and templates reflect Docker/Postgres concerns
  • Secrets are not present in templates or example commands
  • CI includes Docker build/lint/smoke tests for PRs

Breaking Changes

  • This PR includes breaking changes
  • Migration steps included / documented

Screenshots / Logs (if applicable)

Additional Notes

  • The pr_descriptions folder is meant as a template library for contributors. To make a template show automatically in the PR UI, move or copy it to .github/pull_request_template.md or .github/PULL_REQUEST_TEMPLATE/.

Reviewer Notes

  • Focus on labeler rules and issues/PR templates matching the intended repo paths. If you'd like both API and DB templates, consider keeping repo-specific templates in distinct files.

- Update header comment for Bodzify DB Postgres
- Remove API component labels (track, artist, album, etc.)
- Keep type labels for documentation, CI, Docker, and scripts
- Update scripts glob to match .sh files in root directory
- Update PR template to focus on Docker and Postgres
- Update bug report and feature request issue templates to be Docker/Postgres specific
- Update engineering feature template to replace API/Django references
- Change Discussions templates to reference Bodzify DB Postgres
- Update config.yml to point to Postgres repo's discussions
@Andreas-Garcia Andreas-Garcia merged commit 7fee773 into main Dec 9, 2025
@Andreas-Garcia Andreas-Garcia deleted the chore/improve-docs branch December 9, 2025 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants