More robust PR template and contributing guidelines#827
Open
kennethshsu wants to merge 2 commits into
Open
Conversation
Collaborator
Author
|
@genedan @henrydingliu @jbogaardt please share your thoughts, also open to everyone watching this thread. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #827 +/- ##
=======================================
Coverage 86.40% 86.40%
=======================================
Files 86 86
Lines 4959 4959
Branches 642 642
=======================================
Hits 4285 4285
Misses 478 478
Partials 196 196
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of Changes
Improved the contribution guidelines and the PR template
Related GitHub Issue(s)
N/A
Additional Context for Reviewers
To better protect the quality of work of this package, I'd like to propose we put a few more guardrails on PRs so that anyone looking at this package knows there's a certain level of quality that is expected.
The CAS Primer says that we should have a human in the loop and discloses AI tools used.
The code says only Qualified actuarial on the with basis of basic, continuing ed, and experience met shall perform actuarial services. I think we should ask pull requests to make a self declaration if that's not the case.
There's also a bunch more relevant ASOPs that I skimmed through, like ASOP 23 Data Quality, ASOP 41 on Actuarial Communications, and ASOP 56 on Modeling that we should all consider, but I don't think it's necessary to bring them all in as a checklist in the PR template.
Anyway, this is coming in as a PR, and I don't want to just introduce red tape, I'm also not married to these at all. Open to discussion.
uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)Note
Low Risk
Low risk documentation-only change that updates contributor guidance and PR requirements; main impact is on contributor workflow/expectations, not runtime behavior.
Overview
Updates the PR template to add guidance comments and a new checklist requiring local test runs, AI usage disclosure, and contributor attestations (including CAS credential disclosure when applicable).
Tightens
docs/library/contributing.mdPR guidelines by explicitly requiring use of the PR template, disclosure of AI coding agents, and qualified actuarial peer review, and updates the test command example touv run pytest.Reviewed by Cursor Bugbot for commit a60a95a. Bugbot is set up for automated code reviews on this repo. Configure here.