Skip to content

Commit 2cb6992

Browse files
committed
feat: Add CI workflow configuration and contributing guidelines
1 parent a4c1c88 commit 2cb6992

2 files changed

Lines changed: 59 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
push:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
python-version: ["3.10", "3.11", "3.12", "3.13"]
15+
steps:
16+
- uses: actions/checkout@v4
17+
- uses: actions/setup-python@v5
18+
with:
19+
python-version: ${{ matrix.python-version }}
20+
- run: pip install -e .
21+
- run: pip install pytest
22+
- run: pytest tests/ -q

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to DashaFlow
2+
3+
## Getting Started
4+
5+
1. Fork the repo and clone your fork
6+
2. Create a virtual environment: `python -m venv .venv && .venv\Scripts\activate` (or `source .venv/bin/activate` on Linux/Mac)
7+
3. Install in dev mode: `pip install -e . && pip install pytest`
8+
4. Run tests: `pytest tests/ -q`
9+
10+
## Making Changes
11+
12+
1. Create a branch from `main`: `git checkout -b feature/your-feature`
13+
2. Make your changes
14+
3. Add/update tests for any new functionality
15+
4. Ensure all tests pass: `pytest tests/ -q`
16+
5. Commit with a clear message (e.g. `feat: add D45 varga support`)
17+
6. Push and open a Pull Request against `main`
18+
19+
## Code Style
20+
21+
- Follow existing patterns in the codebase
22+
- All astronomical calculations must use Swiss Ephemeris (Sidereal Lahiri)
23+
- Add tests for new features in `tests/`
24+
25+
## What We're Looking For
26+
27+
- New varga calculations
28+
- Additional yoga detections
29+
- Bug fixes with test cases
30+
- Documentation improvements
31+
32+
## Reporting Issues
33+
34+
Open a GitHub issue with:
35+
- What you expected vs what happened
36+
- Birth data that reproduces the issue (use test data, not real personal data)
37+
- Python version and OS

0 commit comments

Comments
 (0)