Skip to content
Merged
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
37 changes: 18 additions & 19 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Bug report
description: Report reproducible incorrect behavior in ecosystem policy or tooling
description: Report reproducible incorrect behavior in ml4t-data
title: "[Bug]: "
labels:
- "type: bug"
Expand All @@ -10,22 +10,10 @@ body:
- type: markdown
attributes:
value: |
Search existing issues first. Do not disclose suspected vulnerabilities here.
- type: dropdown
id: library
attributes:
label: Affected library
options:
- data
- engineer
- backtest
- specs
- live
- diagnostic
- models
- ecosystem
validations:
required: true
Search existing issues first. Report one problem per issue and use separate issues for
unrelated problems. Read the
[shared contribution policy](https://github.com/ml4t/ecosystem/blob/main/CONTRIBUTING.md)
before submitting. Do not disclose suspected vulnerabilities here.
- type: input
id: version
attributes:
Expand All @@ -37,7 +25,8 @@ body:
id: environment
attributes:
label: Environment
description: Include Python version, operating system, installation method, and relevant extras.
description: >-
Include Python version, operating system, installation method, and relevant extras.
validations:
required: true
- type: textarea
Expand All @@ -56,7 +45,17 @@ body:
id: reproduction
attributes:
label: Minimal reproduction
description: Provide the smallest complete example and error output.
description: Provide the smallest complete public API or user workflow and its error output.
validations:
required: true
- type: dropdown
id: numerical
attributes:
label: Numerical impact
options:
- Produces an incorrect numerical result
- Changes a documented definition or convention
- No known numerical impact
validations:
required: true
- type: dropdown
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ contact_links:
- name: Security vulnerability
url: https://github.com/ml4t/data/security/advisories/new
about: Report suspected vulnerabilities privately.
- name: Usage questions
url: https://github.com/orgs/ml4t/discussions
about: Ask questions that do not describe a defect or requested change.
- name: Documentation and usage guidance
url: https://www.ml4trading.io/docs/data/
about: Read the supported workflows and provider guidance before opening an issue.
20 changes: 6 additions & 14 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,13 @@ labels:
- "status: needs-triage"
- "compatibility: none"
body:
- type: dropdown
id: library
- type: markdown
attributes:
label: Affected library
options:
- data
- engineer
- backtest
- specs
- live
- diagnostic
- models
- ecosystem
validations:
required: true
value: |
Search existing issues first. Report one documentation problem per issue and separate
unrelated changes. Read the
[shared contribution policy](https://github.com/ml4t/ecosystem/blob/main/CONTRIBUTING.md)
before submitting.
- type: input
id: version
attributes:
Expand Down
20 changes: 6 additions & 14 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,13 @@ labels:
- "status: needs-triage"
- "compatibility: affected"
body:
- type: dropdown
id: library
- type: markdown
attributes:
label: Owning library
options:
- data
- engineer
- backtest
- specs
- live
- diagnostic
- models
- ecosystem
validations:
required: true
value: |
Search existing issues first. Describe one coherent change per issue and separate unrelated
requests. Discuss the intended behavior here before opening a pull request. Read the
[shared contribution policy](https://github.com/ml4t/ecosystem/blob/main/CONTRIBUTING.md)
before submitting.
- type: input
id: version
attributes:
Expand Down
38 changes: 31 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,50 @@
Read the [ML4T contribution policy](https://github.com/ml4t/ecosystem/blob/main/CONTRIBUTING.md)
before submitting.

## Owning issue

Closes #

The issue and this pull request each describe one problem or coherent change. Separate unrelated
fixes. Automated dependency updates and administrative metadata changes are exempt from the issue
requirement.

## Outcome

Describe the user-visible or standards outcome.
Describe the problem, expected behavior, and what this change does.

## Compatibility
## Compatibility and numerical behavior

- [ ] No public compatibility impact
- [ ] Compatibility impact is documented in the owning issue and migration guidance
- [ ] No numerical result or documented definition changes
- [ ] A numerical defect is reproduced below and corrected by this change
- [ ] An intended definition or convention change was agreed in the owning issue and documented

## Verification

- [ ] Tests reproduce the prior failure or verify the requested behavior
For a bug fix, run the same regression through the affected public API or user workflow on both
revisions:

- Base revision, command, and failing result:
- Pull-request revision, same command, and passing result:

For other changes, state the relevant commands and results.

- [ ] Verification exercises the affected public API or user workflow
- [ ] Ruff lint and format checks pass
- [ ] `ty` passes
- [ ] Test suite passes
- [ ] Package build passes when applicable
- [ ] Strict MkDocs build passes when documentation is affected
- [ ] The applicable test lanes pass
- [ ] The package build passes when applicable
- [ ] Strict MkDocs passes when documentation is affected
- [ ] Ecosystem qualification passes

## AI assistance

State whether AI tools helped produce code or prose and identify the affected parts.

- [ ] I reviewed and tested this submission and can explain its code, prose, and evidence

## Documentation and release

State the documentation, release notes, and patch-release work required after merge.
State the documentation, release-note, and patch-release work required after merge.
Loading
Loading