Repository navigation
docs: adopt shared contribution policy in Backtest - #135
Merged
Merged
Conversation
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.
Owning issue
Closes #134
Outcome
Adds Backtest's contributor entry point and README link to the published ML4T policy. Issue forms ask for one problem and actual AI assistance. The PR template requires a focused change, public-workflow base/fix evidence, executed checks and compatibility impact. Automated dependency and administrative changes retain their owning-issue exception.
Numerical reports must establish the intended result independently of earlier output. Changes to definitions, annualization, sign conventions or defaults require an owning-issue decision and compatibility explanation.
The chooser's Usage documentation contact links the Backtest user guide. Its former organization Discussions URL returned HTTP 404. Private security reporting is preserved.
Compatibility
Contributor guidance and templates only; no runtime or public API change.
Verification
At
e5b5f077ba558c93cdbcf02762bf5b4f359897ae, the full suite passed: 2,261 passed, 14 skipped, 87.43% coverage. Strict MkDocs, 8,792 rendered link checks, focused YAML checks and hooks passed. The usage destination was verified with an actual GET.The current reviewed head is
11f24dc1509a15585e4672f94473233d0b7e20cf; its substantive diff is unchanged. Main refreshes passed hooks and Python support contracts. Exact-head hosted qualification will be reconciled after its selected refresh before merge. A local docs-only check is not a claim that the final hosted matrix has completed.AI assistance
Codex drafted and reviewed the guide, issue/PR templates and this description; reproduced the broken contact route; and ran the reported checks. These are agent-run checks. No independent human review is asserted.
Documentation and release
Verify the contributor guide and README link on main after merge. No package release is needed for these text changes.