mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-12 21:48:56 +00:00
feat: update go version, renovate config, tooling, fixes (#28)
* feat(deps): update go version, renovate config, tooling * chore(deps): update google/go-github to v74 * feat(deps): migrate from yaml.v3 to goccy/go-yaml * chore(deps): update goccy/go-yaml to v1.18.0 and address security concerns * feat: improve issue templates and project configuration - Update GitHub issue templates with CLI-specific fields for better bug reports - Add specialized templates for documentation, theme, and performance issues - Update pre-commit config to include comprehensive documentation linting - Remove outdated Snyk configuration and security references - Update Go version from 1.23+ to 1.24+ across project - Streamline README.md organization and improve clarity - Update CHANGELOG.md and CLAUDE.md formatting - Create comprehensive CONTRIBUTING.md with development guidelines - Remove TODO.md (replaced by docs/roadmap.md) - Move SECURITY.md to docs/security.md * docs: fix markdown linting violations across documentation * fix: resolve template placeholder issues and improve uses statement generation * fix: remove trailing whitespace from GitHub issue template
This commit is contained in:
60
.github/ISSUE_TEMPLATE/feature_request.md
vendored
60
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,20 +1,66 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
about: Suggest an enhancement for gh-action-readme
|
||||
title: '[FEATURE] '
|
||||
labels: enhancement
|
||||
assignees: ivuorinen
|
||||
|
||||
---
|
||||
|
||||
**Feature category**
|
||||
What type of enhancement is this?
|
||||
|
||||
- [ ] New theme
|
||||
- [ ] New output format
|
||||
- [ ] CLI command enhancement
|
||||
- [ ] Validation improvement
|
||||
- [ ] Configuration option
|
||||
- [ ] Template customization
|
||||
- [ ] Performance optimization
|
||||
- [ ] Integration (CI/CD, tools)
|
||||
- [ ] Other: ___________
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
Describe the current limitation or friction in your GitHub Actions documentation workflow.
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
A clear description of the desired functionality. Include:
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
- Proposed CLI syntax (if applicable)
|
||||
- Expected behavior
|
||||
- Sample input/output
|
||||
|
||||
**Use case and impact**
|
||||
Describe your specific GitHub Actions documentation scenario:
|
||||
|
||||
- What types of actions would benefit?
|
||||
- How many action.yml files does this affect?
|
||||
- What workflow improvement would this provide?
|
||||
|
||||
**Proposed implementation**
|
||||
If you have ideas about implementation:
|
||||
|
||||
- New CLI flags: `--flag-name`
|
||||
- Configuration options
|
||||
- Template modifications
|
||||
- Integration points
|
||||
|
||||
**Sample action.yml**
|
||||
Provide a sample action.yml that would showcase this feature:
|
||||
|
||||
```yaml
|
||||
# Example action.yml that would benefit from this feature
|
||||
```
|
||||
|
||||
**Expected output**
|
||||
Show what the generated documentation should look like:
|
||||
|
||||
```markdown
|
||||
# Expected documentation output
|
||||
```
|
||||
|
||||
**Alternatives considered**
|
||||
Describe alternative solutions or workarounds you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
Add any other context, mockups, or examples about the feature request.
|
||||
|
||||
Reference in New Issue
Block a user