mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-16 18:50:32 +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:
72
.github/ISSUE_TEMPLATE/bug_report.md
vendored
72
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,7 +1,7 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
about: Report a bug with gh-action-readme CLI tool
|
||||
title: '[BUG] '
|
||||
labels: bug
|
||||
assignees: ivuorinen
|
||||
|
||||
@@ -10,29 +10,59 @@ assignees: ivuorinen
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
**Command executed**
|
||||
The exact gh-action-readme command that caused the issue:
|
||||
|
||||
```bash
|
||||
gh-action-readme [your command here]
|
||||
```
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
Describe what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
**Actual behavior**
|
||||
Describe what actually happened instead.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
**Sample action.yml**
|
||||
Provide the action.yml content that causes the issue (anonymize sensitive data):
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
```yaml
|
||||
# Paste your action.yml content here
|
||||
```
|
||||
|
||||
**Generated output (if applicable)**
|
||||
If documentation was generated, paste the problematic output:
|
||||
|
||||
```markdown
|
||||
# Paste generated documentation excerpt here
|
||||
```
|
||||
|
||||
## Environment information
|
||||
|
||||
- OS: [e.g. macOS 14.1, Ubuntu 22.04, Windows 11]
|
||||
- gh-action-readme version: [run `gh-action-readme version`]
|
||||
- Go version: [run `go version`]
|
||||
- Installation method: [binary, homebrew, go install, docker]
|
||||
- Theme used: [github, gitlab, minimal, professional, default]
|
||||
- Output format: [md, html, json, asciidoc]
|
||||
|
||||
**Repository structure (if relevant)**
|
||||
If the issue is related to file discovery or recursive processing:
|
||||
|
||||
```text
|
||||
my-repo/
|
||||
├── action.yml
|
||||
├── .github/
|
||||
│ └── workflows/
|
||||
└── other files...
|
||||
```
|
||||
|
||||
**Error messages**
|
||||
Paste any error messages or logs:
|
||||
|
||||
```text
|
||||
[paste error output here]
|
||||
```
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
Add any other context about the problem here (configuration files, special setup, etc.).
|
||||
|
||||
Reference in New Issue
Block a user