fix: correct policy-enforcement.yml path and scaffold required repo structure - #8
Open
mr-adonis-jimenez wants to merge 10 commits into
Open
fix: correct policy-enforcement.yml path and scaffold required repo structure#8mr-adonis-jimenez wants to merge 10 commits into
mr-adonis-jimenez wants to merge 10 commits into
Conversation
There was a problem hiding this comment.
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.
| ## Getting Started | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create a branch following the naming convention: `feature/`, `bugfix/`, `hotfix/`, or `chore/` |
There was a problem hiding this comment.
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`). |
| @@ -0,0 +1 @@ | |||
|
|
|||
There was a problem hiding this comment.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes two issues causing
Validate Repository Structureworkflow failures:1. Move
policy-enforcement.ymlto correct path.github/workflows/.github/workflows/path (GitHub Actions ignores it there).github/workflows/policy-enforcement.ymlpath2. Scaffold missing required directories and files
The
validate-repo-structure.ymlworkflow enforces the presence of these — all were missing:Directories:
model/— financial model assetsdocs/— documentationscripts/— automation scriptsdata/— data filesscreenshots/— UI/output screenshotsDocumentation files:
docs/METHODOLOGY.mddocs/ASSUMPTIONS.mdCONTRIBUTING.mdAll scaffold files are stubs ready to be filled in.