Skip to content

fix: correct policy-enforcement.yml path and scaffold required repo structure - #8

Open
mr-adonis-jimenez wants to merge 10 commits into
mainfrom
fix/policy-enforcement-and-scaffold
Open

fix: correct policy-enforcement.yml path and scaffold required repo structure#8
mr-adonis-jimenez wants to merge 10 commits into
mainfrom
fix/policy-enforcement-and-scaffold

Conversation

@mr-adonis-jimenez

Copy link
Copy Markdown
Owner

Summary

Fixes two issues causing Validate Repository Structure workflow failures:

1. Move policy-enforcement.yml to correct path

  • Removed the file from the nested .github/workflows/.github/workflows/ path (GitHub Actions ignores it there)
  • Re-created it at the correct .github/workflows/policy-enforcement.yml path

2. Scaffold missing required directories and files

The validate-repo-structure.yml workflow enforces the presence of these — all were missing:

Directories:

  • model/ — financial model assets
  • docs/ — documentation
  • scripts/ — automation scripts
  • data/ — data files
  • screenshots/ — UI/output screenshots

Documentation files:

  • docs/METHODOLOGY.md
  • docs/ASSUMPTIONS.md
  • CONTRIBUTING.md

All scaffold files are stubs ready to be filled in.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request establishes the project's foundational structure by introducing a contribution guide, documentation templates, and necessary directory placeholders. The review feedback suggests improving the clarity of the branch naming instructions with a concrete example and notes that a referenced image in the README is missing from the new screenshots directory, which would result in a broken link.

Comment thread CONTRIBUTING.md
## Getting Started

1. Fork the repository
2. Create a branch following the naming convention: `feature/`, `bugfix/`, `hotfix/`, or `chore/`

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

To improve clarity for new contributors, it would be helpful to provide a full example of a branch name here. The current text only lists the prefixes, which might be slightly ambiguous.

Suggested change
2. Create a branch following the naming convention: `feature/`, `bugfix/`, `hotfix/`, or `chore/`
2. Create a branch following the naming convention detailed below (e.g., `feature/add-new-button`).

Comment thread screenshots/.gitkeep
@@ -0,0 +1 @@

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The README.md file references an image at screenshots/dashboard-overview.png. Since this PR creates the screenshots directory but does not add the image, the link in the README.md will be broken. Please consider adding a placeholder image or commenting out the image link in README.md to avoid this.

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.

1 participant