Skip to content
Open
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -65,4 +65,4 @@ jobs:
fi

- name: Policy checks passed
run: echo "✅ All policy checks passed"
run: echo "✅ All policy checks passed"
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
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/`

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`).

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
1 change: 1 addition & 0 deletions data/.gitkeep
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

11 changes: 11 additions & 0 deletions docs/ASSUMPTIONS.md
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._
15 changes: 15 additions & 0 deletions docs/METHODOLOGY.md
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.
1 change: 1 addition & 0 deletions model/.gitkeep
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions screenshots/.gitkeep
Original file line number Diff line number Diff line change
@@ -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.

1 change: 1 addition & 0 deletions scripts/.gitkeep
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Loading