diff --git a/.github/workflows/.github/workflows/policy-enforcement.yml b/.github/workflows/policy-enforcement.yml similarity index 90% rename from .github/workflows/.github/workflows/policy-enforcement.yml rename to .github/workflows/policy-enforcement.yml index 5471718..5894884 100644 --- a/.github/workflows/.github/workflows/policy-enforcement.yml +++ b/.github/workflows/policy-enforcement.yml @@ -28,7 +28,7 @@ jobs: run: | BRANCH_NAME="${{ github.head_ref }}" echo "Checking branch: $BRANCH_NAME" - if [[ ! "$BRANCH_NAME" =~ ^(main|feature\/.+|bugfix\/.+|hotfix\/.+|chore\/.+)$ ]]; then + if [[ ! "$BRANCH_NAME" =~ ^(main|feature\/.+|fix\/.+|bugfix\/.+|hotfix\/.+|chore\/.+|ci\/.+|docs\/.+|refactor\/.+)$ ]]; then echo "❌ Invalid branch naming convention" exit 1 fi @@ -65,4 +65,4 @@ jobs: fi - name: Policy checks passed - run: echo "✅ All policy checks passed" + run: echo "✅ All policy checks passed" \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f8d1d85 --- /dev/null +++ b/CONTRIBUTING.md @@ -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/` +- `bugfix/` +- `hotfix/` +- `chore/` + +## Code Standards + +- Keep files under 5MB +- Ensure required directories exist: `model/`, `docs/`, `scripts/`, `data/`, `screenshots/` +- All documentation should be in Markdown format diff --git a/data/.gitkeep b/data/.gitkeep new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/data/.gitkeep @@ -0,0 +1 @@ + diff --git a/docs/ASSUMPTIONS.md b/docs/ASSUMPTIONS.md new file mode 100644 index 0000000..b06a286 --- /dev/null +++ b/docs/ASSUMPTIONS.md @@ -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._ diff --git a/docs/METHODOLOGY.md b/docs/METHODOLOGY.md new file mode 100644 index 0000000..9918495 --- /dev/null +++ b/docs/METHODOLOGY.md @@ -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. diff --git a/model/.gitkeep b/model/.gitkeep new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/model/.gitkeep @@ -0,0 +1 @@ + diff --git a/screenshots/.gitkeep b/screenshots/.gitkeep new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/screenshots/.gitkeep @@ -0,0 +1 @@ + diff --git a/scripts/.gitkeep b/scripts/.gitkeep new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/scripts/.gitkeep @@ -0,0 +1 @@ +