mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-10 22:48:08 +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:
113
.github/ISSUE_TEMPLATE/theme_request.md
vendored
Normal file
113
.github/ISSUE_TEMPLATE/theme_request.md
vendored
Normal file
@@ -0,0 +1,113 @@
|
||||
---
|
||||
name: Theme request
|
||||
about: Request a new theme or theme improvements
|
||||
title: '[THEME] '
|
||||
labels: enhancement, theme
|
||||
assignees: ivuorinen
|
||||
|
||||
---
|
||||
|
||||
**Theme request type**
|
||||
What kind of theme enhancement is this?
|
||||
|
||||
- [ ] New theme for a specific platform/use case
|
||||
- [ ] Improvements to existing theme
|
||||
- [ ] Theme bug fix
|
||||
- [ ] Theme customization options
|
||||
|
||||
**Target platform/use case**
|
||||
What platform or scenario is this theme designed for?
|
||||
|
||||
- [ ] GitHub Marketplace optimization
|
||||
- [ ] GitLab CI/CD documentation
|
||||
- [ ] Azure DevOps integration
|
||||
- [ ] Internal/Enterprise documentation
|
||||
- [ ] Minimal/lightweight documentation
|
||||
- [ ] Mobile-friendly documentation
|
||||
- [ ] Other: ___________
|
||||
|
||||
**Visual requirements**
|
||||
Describe the desired appearance and formatting:
|
||||
|
||||
**Badges and shields:**
|
||||
|
||||
- [ ] Platform-specific badges
|
||||
- [ ] Version/release shields
|
||||
- [ ] Build status badges
|
||||
- [ ] License/security badges
|
||||
- [ ] Custom badge styling
|
||||
|
||||
**Layout preferences:**
|
||||
|
||||
- [ ] Table of contents
|
||||
- [ ] Collapsible sections
|
||||
- [ ] Multi-column layout
|
||||
- [ ] Sidebar navigation
|
||||
- [ ] Card-based layout
|
||||
- [ ] Minimal typography
|
||||
|
||||
**Color scheme:**
|
||||
|
||||
- [ ] Dark theme
|
||||
- [ ] Light theme
|
||||
- [ ] Platform-specific colors (GitHub green, GitLab orange, etc.)
|
||||
- [ ] Corporate/brand colors
|
||||
- [ ] High contrast for accessibility
|
||||
|
||||
**Sample action.yml files**
|
||||
Provide example action.yml files to test the theme with:
|
||||
|
||||
```yaml
|
||||
# Example 1: Simple action
|
||||
name: Simple Action
|
||||
description: A basic action example
|
||||
inputs:
|
||||
input1:
|
||||
description: First input
|
||||
required: true
|
||||
outputs:
|
||||
output1:
|
||||
description: First output
|
||||
runs:
|
||||
using: node20
|
||||
main: index.js
|
||||
```
|
||||
|
||||
```yaml
|
||||
# Example 2: Complex action (if applicable)
|
||||
# Add more complex action.yml if theme needs to handle advanced cases
|
||||
```
|
||||
|
||||
**Reference examples**
|
||||
Provide links or descriptions of documentation that exemplifies the desired style:
|
||||
|
||||
- [ ] Link to well-styled action documentation
|
||||
- [ ] Screenshots of desired layout
|
||||
- [ ] Reference to design system or style guide
|
||||
- [ ] Examples from other tools/platforms
|
||||
|
||||
**Expected output preview**
|
||||
Mock up what the generated documentation should look like:
|
||||
|
||||
```markdown
|
||||
# Show expected theme output here
|
||||
# Include formatting, badges, layout structure
|
||||
```
|
||||
|
||||
**Existing theme starting point**
|
||||
Which existing theme should this be based on?
|
||||
|
||||
- [ ] Start from scratch
|
||||
- [ ] Extend `github` theme
|
||||
- [ ] Extend `gitlab` theme
|
||||
- [ ] Extend `minimal` theme
|
||||
- [ ] Extend `professional` theme
|
||||
- [ ] Extend `default` theme
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the theme request:
|
||||
|
||||
- Specific markdown features needed
|
||||
- Integration requirements
|
||||
- Performance considerations
|
||||
- Accessibility requirements
|
||||
Reference in New Issue
Block a user