-
Notifications
You must be signed in to change notification settings - Fork 0
fix: correct policy-enforcement.yml path and scaffold required repo structure #8
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
Open
mr-adonis-jimenez
wants to merge
10
commits into
main
Choose a base branch
from
fix/policy-enforcement-and-scaffold
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
4354c47
fix: move policy-enforcement.yml to correct workflows path
mr-adonis-jimenez 591cfff
fix: remove misplaced nested policy-enforcement.yml
mr-adonis-jimenez c5c6861
chore: scaffold model directory
mr-adonis-jimenez efba7ec
chore: scaffold scripts directory
mr-adonis-jimenez ecf5cbb
chore: scaffold data directory
mr-adonis-jimenez 8191c47
chore: scaffold screenshots directory
mr-adonis-jimenez 3f94134
docs: add METHODOLOGY.md scaffold
mr-adonis-jimenez 0bdbf9f
docs: add ASSUMPTIONS.md scaffold
mr-adonis-jimenez 11b752c
docs: add CONTRIBUTING.md scaffold
mr-adonis-jimenez 31bc6f9
fix: add fix/, ci/, docs/, refactor/ to allowed branch naming patterns
mr-adonis-jimenez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # Contributing | ||
|
|
||
| Thank you for your interest in contributing to this project! | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create a branch following the naming convention: `feature/`, `bugfix/`, `hotfix/`, or `chore/` | ||
| 3. Make your changes | ||
| 4. Open a pull request against `main` | ||
|
|
||
| ## Branch Naming | ||
|
|
||
| Branches must follow the pattern: | ||
| - `feature/<description>` | ||
| - `bugfix/<description>` | ||
| - `hotfix/<description>` | ||
| - `chore/<description>` | ||
|
|
||
| ## Code Standards | ||
|
|
||
| - Keep files under 5MB | ||
| - Ensure required directories exist: `model/`, `docs/`, `scripts/`, `data/`, `screenshots/` | ||
| - All documentation should be in Markdown format | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Assumptions | ||
|
|
||
| This document lists the key assumptions underlying the financial models in this project. | ||
|
|
||
| ## General Assumptions | ||
|
|
||
| _To be completed._ | ||
|
|
||
| ## Data Assumptions | ||
|
|
||
| _To be completed._ |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Methodology | ||
|
|
||
| This document describes the methodology used in the Financial Model API Dev Tools project. | ||
|
|
||
| ## Overview | ||
|
|
||
| _To be completed._ | ||
|
|
||
| ## Modeling Approach | ||
|
|
||
| _To be completed._ | ||
|
|
||
| ## Assumptions | ||
|
|
||
| See [ASSUMPTIONS.md](ASSUMPTIONS.md) for a full list of assumptions. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.