Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
## Summary of Changes
<!-- Keep this short and concise, with a few sentences max. Make sure it accurately reflects the PR subject line, which will be used in the release notes. -->


## Related GitHub Issue(s)
<!-- e.g. #123. Use "Closes", "Fixes", or "Resolves" before the number (e.g. "Closes #123") to auto close the issue when this PR is merged, e.g. "Closes #123". -->


## Additional Context for Reviewers
<!-- Include any additional info that would be helpful for reviewers. If applicable, disclose any AI tools used and if AI-generated content dominates the diffs. You do not need to disclose AI tools used visible to the public (e.g. bugbot). -->


## 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.
26 changes: 15 additions & 11 deletions docs/library/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
Loading