Skip to content

#1238 deploy governing doc - #1242

Open
kennethshsu wants to merge 9 commits into
mainfrom
#1238_deploy_governing_doc
Open

#1238 deploy governing doc#1242
kennethshsu wants to merge 9 commits into
mainfrom
#1238_deploy_governing_doc

Conversation

@kennethshsu

@kennethshsu kennethshsu commented Aug 28, 2026

Copy link
Copy Markdown
Member

Summary of Changes

Straight deployment of the governing doc and converted into a MD file

Related GitHub Issue(s)

Closes #1238

Additional Context for Reviewers

No words changed from the GDocs' version, except:

  • Added a link to the contributing guide under section 4
  • Removed the TODO under "Review Principles" about TDD. I think we can add this later (if needed).
  • Added the page title
  • Added a hyphen to the "dev-branches"
  • Capitalized the I in "PyPI"

Checklist

  • I passed tests locally for both code (uv run pytest) and documentation changes (uv run --directory docs jb build . --builder=custom --custom-builder=doctest)

Note

Low Risk
Documentation-only change with no runtime, API, or CI behavior changes; future PRs may be held to new stated governance requirements.

Overview
Adds docs/library/governance.md to the doc site as the official Governing Doc for chainladder-python under CAS OSPWG, covering governance roles, maintainer eligibility and voting, development standards (Pandas/sklearn/Ruff), contribution workflow (branching, PR prefixes, AI disclosure, review/CI, emergency hotfixes), releases (semver, PyPI/conda publishing), security, citation, and code of conduct.

docs/_toc.yml now lists the page under the library About section (ahead of usage and contributing). Compared to the source Google Doc, this PR adds a link to contributing.md in the dev-environment section and drops a TDD TODO from Review Principles.

Reviewed by Cursor Bugbot for commit 4872412. Bugbot is set up for automated code reviews on this repo. Configure here.

@kennethshsu
kennethshsu marked this pull request as draft August 28, 2026 23:56
@github-actions

github-actions Bot commented Aug 28, 2026

Copy link
Copy Markdown

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 15.2% of exported symbols fully typed (209 / 1377)

Known Ambiguous Unknown Total
Project (head) 209 111 1057 1377

Other symbols referenced but not exported by chainladder: 13

Known Ambiguous Unknown Total
Other (head) 3 1 9 13

Symbols without documentation:

  • Functions without docstring: 325
  • Functions without default param: 0
  • Classes without docstring: 10

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

@codecov

codecov Bot commented Aug 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.70%. Comparing base (e07c09e) to head (4872412).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1242   +/-   ##
=======================================
  Coverage   91.70%   91.70%           
=======================================
  Files          93       93           
  Lines        5438     5438           
  Branches      699      699           
=======================================
  Hits         4987     4987           
  Misses        327      327           
  Partials      124      124           
Flag Coverage Δ
unittests 91.70% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kennethshsu
kennethshsu marked this pull request as ready for review August 29, 2026 04:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deploy the Governing Doc to the doc site

1 participant