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
193 changes: 193 additions & 0 deletions .github/ISSUE_TEMPLATE/stm32-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
name: STM32 Bug Report
description: Report a bug or issue with STM32 platform support
title: "[STM32] "
labels: ["bug", "stm32", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report for STM32 platform support!

Please provide as much detail as possible to help us reproduce and fix the issue.

- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
description: Please verify these items before submitting the bug report
options:
- label: I have searched existing issues and this is not a duplicate
required: true
- label: I have tested with the latest version of FluidNC
required: true
- label: I have tried building offline using `./build-offline.sh`
required: false
- label: I have checked the build system documentation
required: false

- type: dropdown
id: stm32_board
attributes:
label: STM32 Board
description: Which STM32 board or configuration are you using?
options:
- STM32F103C8 (stm32_noradio)
- STM32F401CC (stm32_basic)
- STM32F407VG (stm32_advanced)
- Custom STM32 board
- Unknown/Not sure
default: 0
validations:
required: true

- type: dropdown
id: build_environment
attributes:
label: Build Environment
description: Which build environment are you using?
options:
- stm32_noradio
- stm32_basic
- stm32_advanced
- Custom environment
default: 0
validations:
required: true

- type: dropdown
id: operating_system
attributes:
label: Operating System
description: Which operating system are you using?
options:
- Windows
- macOS
- Linux (Ubuntu/Debian)
- Linux (Other)
- Other
default: 0
validations:
required: true

- type: textarea
id: bug_description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is
placeholder: Describe the bug...
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen
placeholder: What should have happened...
validations:
required: true

- type: textarea
id: actual_behavior
attributes:
label: Actual Behavior
description: A clear and concise description of what actually happened
placeholder: What actually happened...
validations:
required: true

- type: textarea
id: reproduction_steps
attributes:
label: Steps to Reproduce
description: Detailed steps to reproduce the issue
placeholder: |
1. Go to '...'
2. Run command '...'
3. See error
validations:
required: true

- type: textarea
id: build_output
attributes:
label: Build Output
description: If this is a build issue, please provide the complete build output
placeholder: |
```
Paste build output here...
```
render: shell

- type: textarea
id: runtime_logs
attributes:
label: Runtime Logs
description: If this is a runtime issue, please provide serial monitor output
placeholder: |
```
Paste serial monitor output here...
```
render: shell

- type: textarea
id: configuration
attributes:
label: Configuration
description: Please provide your configuration (platformio.ini changes, config.yaml, etc.)
placeholder: |
```yaml
# Your configuration here
```
render: yaml

- type: textarea
id: hardware_info
attributes:
label: Hardware Information
description: Details about your hardware setup
placeholder: |
- STM32 board: [Board name and version]
- Programmer: [ST-Link, USB, etc.]
- Connected peripherals: [Motors, sensors, etc.]
- Power supply: [Voltage, current rating]

- type: textarea
id: network_environment
attributes:
label: Network Environment
description: If this is a network/firewall related issue, please provide details
placeholder: |
- Network type: [Corporate, Home, Public]
- Firewall: [Yes/No, Type]
- Proxy: [Yes/No, Configuration]
- DNS: [Default, Custom]
- Offline build attempted: [Yes/No]

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Add any other context about the problem here
placeholder: Any additional information that might help...

- type: markdown
attributes:
value: |
## Debug Information

Please also run the following commands and include the output:

```bash
# System information
pio system info

# Platform information
pio platform list

# Build with verbose output
pio run -e stm32_noradio -v

# Network diagnostics (if applicable)
curl -I https://api.registry.platformio.org/
```
203 changes: 203 additions & 0 deletions .github/ISSUE_TEMPLATE/stm32-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
name: STM32 Feature Request
description: Request a new feature for STM32 platform support
title: "[STM32 Feature] "
labels: ["enhancement", "stm32", "feature-request"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature for STM32 platform support!

Please provide as much detail as possible to help us understand and evaluate your request.

- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
description: Please verify these items before submitting the feature request
options:
- label: I have searched existing issues and this is not a duplicate
required: true
- label: I have reviewed the STM32 Implementation Roadmap
required: true
- label: This feature is not already planned or implemented
required: true

- type: dropdown
id: feature_category
attributes:
label: Feature Category
description: What type of feature is this?
options:
- Hardware Support (New STM32 boards/chips)
- Motor Control (Stepper/Servo enhancements)
- Communication (UART/SPI/I2C improvements)
- Display Support (LCD/OLED integration)
- Safety Features (Limits/Emergency stop)
- Configuration System (YAML/Runtime config)
- Build System (Compilation/Deployment)
- Documentation (Guides/Examples)
- Performance Optimization
- Other
default: 0
validations:
required: true

- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Low - Nice to have
- Medium - Would be helpful
- High - Important for my project
- Critical - Blocking my project
default: 1
validations:
required: true

- type: textarea
id: feature_description
attributes:
label: Feature Description
description: A clear and concise description of the feature you'd like to see
placeholder: Describe the feature...
validations:
required: true

- type: textarea
id: use_case
attributes:
label: Use Case
description: Describe the problem this feature would solve or the improvement it would provide
placeholder: |
- What problem does this solve?
- How would you use this feature?
- What would be the benefits?
validations:
required: true

- type: textarea
id: proposed_solution
attributes:
label: Proposed Solution
description: How do you think this feature should be implemented?
placeholder: |
- Configuration options needed
- API changes required
- Hardware requirements
- Software dependencies

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Have you considered any alternative solutions or workarounds?
placeholder: |
- Other approaches you've considered
- Current workarounds you're using
- Why those alternatives are not suitable

- type: dropdown
id: target_boards
attributes:
label: Target STM32 Boards
description: Which STM32 boards should this feature support?
multiple: true
options:
- STM32F103C8 (stm32_noradio)
- STM32F401CC (stm32_basic)
- STM32F407VG (stm32_advanced)
- All current STM32 boards
- New STM32 board (specify in description)
default: 3

- type: textarea
id: hardware_requirements
attributes:
label: Hardware Requirements
description: What hardware is needed for this feature?
placeholder: |
- STM32 chip requirements (flash, RAM, peripherals)
- External components needed
- Pinout requirements
- Power requirements

- type: textarea
id: software_requirements
attributes:
label: Software Requirements
description: What software dependencies or changes are needed?
placeholder: |
- Library dependencies
- Framework requirements
- API changes needed
- Configuration changes

- type: textarea
id: compatibility
attributes:
label: Compatibility Considerations
description: How would this feature interact with existing functionality?
placeholder: |
- ESP32 compatibility
- Backward compatibility
- Breaking changes
- Migration requirements

- type: textarea
id: testing_approach
attributes:
label: Testing Approach
description: How should this feature be tested?
placeholder: |
- Unit tests needed
- Integration tests
- Hardware testing requirements
- Performance testing

- type: textarea
id: documentation_needs
attributes:
label: Documentation Needs
description: What documentation would be needed for this feature?
placeholder: |
- User documentation
- Developer documentation
- Configuration examples
- Troubleshooting guides

- type: textarea
id: implementation_timeline
attributes:
label: Implementation Timeline
description: When do you need this feature? Are you willing to contribute?
placeholder: |
- Desired timeline
- Willingness to contribute code
- Available time for testing
- Resources you can provide

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Add any other context, screenshots, or examples
placeholder: |
- Links to similar implementations
- Screenshots or diagrams
- Code examples
- Reference materials

- type: markdown
attributes:
value: |
## Community Input

This feature request will be reviewed by the FluidNC community and development team. Please consider:

- **Community Benefit**: How would this feature benefit the broader FluidNC community?
- **Maintenance**: Are you willing to help maintain this feature long-term?
- **Contribution**: Can you contribute code, testing, or documentation?
- **Feedback**: Are you open to feedback and iteration on this feature?
Loading
Loading