Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Abosio/474 update test data #1

Merged
merged 2 commits into from
Mar 14, 2025
Merged

Abosio/474 update test data #1

merged 2 commits into from
Mar 14, 2025

Conversation

abosio
Copy link
Contributor

@abosio abosio commented Mar 12, 2025

🎯 What needed to be done and why?

Ticket: sixfeetup/scaf#474

Now that the template is in a separate repo, the test data file(s) for it should live with it.

Probably should wait for the PR for the complimentary main repo changes for that ticket in case any changes are needed.

🆕 What is changed by this PR?

  • Copies the test data file from the main scaf repo nextjs-django-github.yaml
  • Updates the test data file to be compatible with copier
  • excludes *.test-data.yml from copier so that test data files will not be copied into the generated project directory

📋 Code Review Cheatsheet

What the reviewer should check
Check Description
🚚 Diff size Is the PR small and focused, or should it be broken into smaller PRs?
🧪 Unit tests Are new features covered with appropriate unit tests?
🥼 Acceptance Criteria met Are the Acceptance Criteria listed in the issue met?
🧐 Code clarity Is the code easy to understand? Are variable and function names meaningful?
🧩 Code organization Are files, modules, and functions structured logically?
🪚 Conciseness Is the code free of unnecessary complexity or redundant code?
💬 Comments & documentation Are code comments explaining why and not how? Is the documentation up-to-date?
🧮 Code consistency Does the code follow existing patterns and conventions in the project?
☣️ Function length Are functions too long? Should they be broken into smaller, more focused functions?
☢️ Class design Are classes well-structured and not overly large or doing too much?
🐾 Logging and debugging statements Are print/debug statements removed or replaced with proper logging?

abosio added 2 commits March 12, 2025 13:39
so that is doesn't copy test data files to the output directory
@abosio abosio merged commit 816857a into main Mar 14, 2025
abosio added a commit to sixfeetup/scaf that referenced this pull request Mar 14, 2025
## 🎯 What needed to be done and why?

Ticket: #474 

test-scaf.sh script needed to be updated to work with copier

## 🆕 What is changed by this PR?

- updated arguments to match copier
- removed test data file (moved to it's template repo in
sixfeetup/scaf-fullstack-template#1 )
- removed support for git branch since template repo is separate
  - will use whatever branch is checkout out for the template

## 📋 Code Review Cheatsheet

<details>

<summary>What the reviewer should check</summary>

| Check  | Description |
| ------------- | ------------- |
| 🚚 **Diff size** | Is the PR small and focused, or should it be
broken into smaller PRs?
| 🧪 **Unit tests** | Are new features covered with appropriate
unit tests?
| 🥼 **Acceptance Criteria met** | Are the Acceptance Criteria
listed in the issue met?
| 🧐 **Code clarity** | Is the code easy to understand? Are
variable and function names meaningful?
| 🧩 **Code organization** | Are files, modules, and functions
structured logically?
| 🪚 **Conciseness** | Is the code free of unnecessary
complexity or redundant code?
| 💬 **Comments & documentation** | Are code comments
explaining *why* and not *how*? Is the documentation up-to-date?
| 🧮 **Code consistency** | Does the code follow existing patterns
and conventions in the project?
| ☣️ **Function length** | Are functions too long? Should they
be broken into smaller, more focused functions?
| ☢️ **Class design** | Are classes well-structured and not
overly large or doing too much?
| 🐾 **Logging and debugging statements** | Are print/debug
statements removed or replaced with proper logging?

</details>

---------

Co-authored-by: abosio <abosio@sixfeetup.com>
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