File tree Expand file tree Collapse file tree 4 files changed +20
-1
lines changed
Expand file tree Collapse file tree 4 files changed +20
-1
lines changed Original file line number Diff line number Diff line change 99 - policyengine_us_data/**
1010 - tests/**
1111 - .github/workflows/**
12+ - Makefile
1213
1314jobs :
1415 Lint :
Original file line number Diff line number Diff line change 2323- ** Line Length** : 79 characters max (Black configured in pyproject.toml)
2424- ** Python Version** : Targeting Python 3.11
2525
26+ ## Git and PR Guidelines
27+ - ** CRITICAL** : NEVER create PRs from personal forks - ALL PRs MUST be created from branches pushed to the upstream PolicyEngine repository
28+ - CI requires access to secrets that are not available to fork PRs for security reasons
29+ - Fork PRs will fail on data download steps and cannot be merged
30+ - Always create branches directly on the upstream repository:
31+ ``` bash
32+ git checkout main
33+ git pull upstream main
34+ git checkout -b your-branch-name
35+ git push -u upstream your-branch-name
36+ ```
37+ - Use descriptive branch names like ` fix-issue-123 ` or ` add-feature-name `
38+ - Always run ` make format ` before committing
39+
2640## CRITICAL RULES FOR ACADEMIC INTEGRITY
2741
2842### NEVER FABRICATE DATA OR RESULTS
Original file line number Diff line number Diff line change @@ -39,7 +39,7 @@ documentation:
3939 rm -rf _build .jupyter_cache && \
4040 rm -f _toc.yml && \
4141 myst clean && \
42- myst build
42+ timeout 10 myst build --html || true
4343
4444documentation-build :
4545 cd docs && \
Original file line number Diff line number Diff line change 1+ - bump : patch
2+ changes :
3+ fixed :
4+ - Fixed documentation deployment for MyST v2 by using timeout command
You can’t perform that action at this time.
0 commit comments