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
110 changes: 110 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
name: 🐞 Bug report
description: Report reproducible behavior in alpaca-java
title: "[Bug]: "
labels: [bug]
assignees: []
body:
- type: markdown
attributes:
value: |
Report SDK behavior here in English. Bugs in the Alpaca API itself, its OpenAPI specs, or its documentation go to [alpacahq/alpaca-api](https://github.com/alpacahq/alpaca-api/issues/new/choose). API feature requests, general questions, and dashboard bugs go to the [Community Forum](https://forum.alpaca.markets/) or [Slack](https://alpaca.markets/slack). Questions about your account, funding, or orders go to a [support request](https://alpaca.markets/support/request). Service status and incident updates are on the [status page](https://status.alpaca.markets/).

Do not disclose suspected security vulnerabilities publicly. Follow the private reporting process in our [Security Policy](https://github.com/alpacahq/alpaca-java/blob/main/SECURITY.md).

Never include API keys, account details, request or trace IDs, or other secrets.

- type: checkboxes
id: preflight
attributes:
label: Preflight
options:
- label: I searched existing issues and tested the latest applicable SDK release.
required: true
- label: This report concerns SDK behavior. Bugs in the Alpaca API, its OpenAPI specs, or docs.alpaca.markets go to alpacahq/alpaca-api.
required: true

- type: dropdown
id: area
attributes:
label: SDK area
description: Which SDK surface is affected?
options:
- Trading REST
- Broker REST
- Market Data REST
- Trading activity (SSE)
- Broker events (SSE)
- Market Data corporate actions (SSE)
- Trading WebSocket stream
- Market Data WebSocket stream
- Authentication or configuration
- Maven, Gradle, installation, or Java compatibility
- Developer experience
- Documentation or examples
- Other
validations:
required: true

- type: input
id: sdk_version
attributes:
label: SDK version
description: Provide the exact installed alpaca-java version.
placeholder: alpaca-java 0.x.y
validations:
required: true

- type: input
id: environment
attributes:
label: Java version, OS, and architecture
description: Include the output of `java --version` and your operating system and architecture because networking and WebSocket behavior can differ by environment.
placeholder: Java 17.0.12 on macOS arm64
validations:
required: true

- type: input
id: module
attributes:
label: SDK package or class
description: State which SDK package, class, or client is affected.
placeholder: markets.alpaca.client.AlpacaClient

- type: textarea
id: current_behavior
attributes:
label: Current behavior
description: Describe what happens, including safe error output.
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: Expected behavior
description: Describe what you expected instead.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Minimal reproduction
description: Provide the smallest runnable example and exact steps.
render: java
validations:
required: true

- type: textarea
id: additional_context
attributes:
label: Additional context
description: Add sanitized logs or other non-sensitive context. Do not post request IDs, trace IDs, account identifiers, or private diagnostics; share those privately through a [support request](https://alpaca.markets/support/request) or the [Security Policy](https://github.com/alpacahq/alpaca-java/blob/main/SECURITY.md) when appropriate.

- type: checkboxes
id: sensitive_data
attributes:
label: Sensitive-data check
options:
- label: I removed API keys, credentials, account details, request or trace IDs, and other sensitive information.
required: true
80 changes: 0 additions & 80 deletions .github/ISSUE_TEMPLATE/bug_report.yaml

This file was deleted.

20 changes: 13 additions & 7 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
blank_issues_enabled: true
blank_issues_enabled: false
contact_links:
- name: Alpaca API, OpenAPI spec, or docs bug
- name: Alpaca API issue tracker
url: https://github.com/alpacahq/alpaca-api/issues/new/choose
about: Bugs in the Alpaca API itself, its OpenAPI specs, or docs.alpaca.markets.
- name: Community Forum
about: Report bugs in the Alpaca API, its OpenAPI specifications, or docs.alpaca.markets.
- name: Alpaca Support
url: https://alpaca.markets/support
about: Find help articles or contact Alpaca Support about account-specific questions.
- name: Report a security vulnerability
url: https://alpaca.markets/security
about: Follow Alpaca's private vulnerability-disclosure process.
- name: Alpaca Community Forum
url: https://forum.alpaca.markets/
about: API feature requests, general questions, and dashboard bugs.
- name: Community Slack
about: Request API features and discuss general Alpaca API and platform questions.
- name: Alpaca community on Slack
url: https://alpaca.markets/slack
about: API feature requests, general questions, and dashboard bugs.
about: Request API features and chat with developers and the Alpaca community.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-improvement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: 📖 Documentation improvement
description: Suggest an improvement to the alpaca-java documentation
title: "[Docs]: "
labels: [documentation]
assignees: []
body:
- type: markdown
attributes:
value: |
Use this form for this SDK's README files, Javadocs, Docusaurus documentation sourced from `docs/`, and examples. Bugs in docs.alpaca.markets go to [alpacahq/alpaca-api](https://github.com/alpacahq/alpaca-api/issues/new/choose).

Never include API keys, account details, request or trace IDs, or other secrets.

- type: checkboxes
id: preflight
attributes:
label: Preflight
options:
- label: I searched existing issues and confirmed this request concerns documentation maintained by alpaca-java.
required: true

- type: input
id: documentation_location
attributes:
label: Documentation location
description: Link the page or provide the repository path that needs improvement.
placeholder: https://alpacahq.github.io/alpaca-java/... or README.md
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem
description: Explain what is missing, incorrect, outdated, or unclear.
validations:
required: true

- type: textarea
id: proposed_improvement
attributes:
label: Proposed improvement
description: Describe the documentation or example change you would like.
validations:
required: true

- type: textarea
id: additional_context
attributes:
label: Additional context
description: Add safe examples, references, or other relevant details.

- type: checkboxes
id: sensitive_data
attributes:
label: Sensitive-data check
options:
- label: I removed API keys, credentials, account details, request or trace IDs, and other sensitive information.
required: true
95 changes: 70 additions & 25 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,51 +1,96 @@
name: 🚀 Feature request
description: I would like to see a new feature implemented in the SDK
labels: [ kind/feature ]
assignees:
-
description: Propose an improvement to alpaca-java
title: "[Feature]: "
labels: [enhancement]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to request a feature! Please fill the form in English.
Propose SDK-specific work here in English. API feature requests, general questions, and dashboard bugs go to the [Community Forum](https://forum.alpaca.markets/) or [Slack](https://alpaca.markets/slack). Bugs in the Alpaca API itself, its OpenAPI specs, or its documentation go to [alpacahq/alpaca-api](https://github.com/alpacahq/alpaca-api/issues/new/choose).

Read the [contribution policy](https://github.com/alpacahq/alpaca-java/blob/main/CONTRIBUTING.md#contribution-policy) before implementing substantial work or a third-party integration.

- type: checkboxes
id: preflight
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue related to this feature request already exists.
label: Preflight
options:
- label: I have searched the existing issues
- label: I searched existing issues and confirmed this request is specific to the SDK. API feature requests belong on the Community Forum or Slack, not in alpacahq/alpaca-api.
required: true
- label: I understand that substantial work requires maintainer agreement before implementation.
required: true

- type: textarea
- type: dropdown
id: area
attributes:
label: Is your feature request related to a problem? Please describe.
description: A concise description of the problem you are facing or the motivation behind this feature request.
placeholder: |
I faced a problem where ...
label: SDK area
options:
- Trading REST
- Broker REST
- Market Data REST
- Trading activity (SSE)
- Broker events (SSE)
- Market Data corporate actions (SSE)
- Trading WebSocket stream
- Market Data WebSocket stream
- Authentication or configuration
- Maven, Gradle, installation, or Java compatibility
- Developer experience
- Documentation or examples
- Other
validations:
required: true

- type: textarea
id: problem
attributes:
label: Describe the solution you'd like.
description: A concise description of what you would like to see added or changed.
placeholder: |
I would like to be able to ...
label: Problem or use case
description: Explain the concrete SDK problem and who it affects.
validations:
required: false
required: true

- type: textarea
id: proposed_solution
attributes:
label: Describe an alternative solution.
description: Are there any workarounds or alternate approaches you have considered?
label: Proposed SDK change
description: Describe the desired SDK behavior or interface.
validations:
required: false
required: true

- type: input
id: api_documentation
attributes:
label: Relevant Alpaca API documentation
description: Link the documented API capability, or enter "Not applicable" for tooling or documentation work.
placeholder: https://docs.alpaca.markets/...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Describe workarounds or alternative SDK designs.

- type: textarea
id: third_party
attributes:
label: Anything else? (Additional context)
description: |
Links? References? Relevant Alpaca API docs? Anything that will give us more context.
label: Third-party products or services
description: Identify any provider, hosted endpoint, client, referral, dependency, or promotional content involved. Enter "None" when not applicable.
validations:
required: false
required: true

- type: textarea
id: additional_context
attributes:
label: Additional context
description: Add examples, prior discussion, or other relevant details.

- type: checkboxes
id: sensitive_data
attributes:
label: Sensitive-data check
options:
- label: I removed API keys, credentials, account details, request or trace IDs, and other sensitive information.
required: true
Loading
Loading