diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 749641af..bb5f04b2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,16 @@ ## Summary of Changes + ## Related GitHub Issue(s) + ## Additional Context for Reviewers + +## Checklist - [ ] I passed tests locally for both code (`uv run pytest`) and documentation changes (`uv run jb build docs --builder=custom --custom-builder=doctest`) +- [ ] I am an Associate of the Casualty Actuarial Society (ACAS) or a Fellow of the Casualty Actuarial Society (FCAS). +- [ ] I have reviewed every diff in this PR, including both code and documentation changes. I acknowledge that reviewers have the discretion to close any pull request deemed to be too verbose or overly reliant on AI. \ No newline at end of file diff --git a/docs/library/contributing.md b/docs/library/contributing.md index caab7967..b7915167 100644 --- a/docs/library/contributing.md +++ b/docs/library/contributing.md @@ -102,29 +102,33 @@ Contributions to documentation are especially helpful for new users. ## Pull Requests (PRs) -**Guidelines for PRs:** +**Guidelines for PRs:** + +We welcome all pull requests! Please keep in mind that each PR undergoes a thorough, line-by-line quality review and must pass all existing unit tests. Be prepared to answer questions from the maintainers and make revisions as needed. **PRs must:** -- Pass all existing unit tests -- Undergo independent peer review +- Be submitted using the pull request template +- Pass all existing unit tests +- Disclose usage of any AI coding agents +- Undergo independent peer review by another actuary **PRs are encouraged to:** -- Be small, focused, and modular -- Link to relevant Issue ticket(s) -- Include docstring updates for any code changes -- Update the documentation site for corresponding changes -- Follow established naming conventions -- Include new unit tests with reasonable coverage +- Be small, focused, and modular +- Link to relevant Issue ticket(s) +- Include docstring updates for any code changes +- Update the documentation site for corresponding changes +- Follow established naming conventions +- Include new unit tests with reasonable coverage All PRs should be run locally before submission. For codebase tests, run: ```bash -pytest +uv run pytest ``` -For documentation changes, rebuild the docs locally with: +For documentation changes, run: ```bash uv run jb build docs --builder=custom --custom-builder=doctest ```