Skip to content

Add issue templates for bug reports, documentation improvements, and feature requests#74

Merged
marko-stanojevic merged 1 commit intomainfrom
feature/issue_template
Jan 2, 2026
Merged

Add issue templates for bug reports, documentation improvements, and feature requests#74
marko-stanojevic merged 1 commit intomainfrom
feature/issue_template

Conversation

@marko-stanojevic
Copy link
Contributor

@marko-stanojevic marko-stanojevic commented Jan 2, 2026

This pull request introduces several improvements to the GitHub issue reporting and workflow configuration for the repository. The main focus is on adding structured issue templates for bug reports, feature requests, and documentation improvements, as well as updating the workflow for release note generation. These changes aim to streamline community contributions and improve the quality and consistency of reported issues.

Issue template additions:

  • Added a comprehensive bug report template in .github/ISSUE_TEMPLATE/bug_report.yml to guide users in providing detailed information for troubleshooting, including environment details and code samples.
  • Added a feature request template in .github/ISSUE_TEMPLATE/feature_request.yml to collect structured feedback on new features, including problem statements, proposed solutions, and willingness to contribute.
  • Added a documentation improvement template in .github/ISSUE_TEMPLATE/documentation.yml to enable users to suggest and describe documentation enhancements in a standardized format.

Configuration and workflow updates:

  • Updated .github/ISSUE_TEMPLATE/config.yml to enable blank issues and add contact links for questions, discussions, and security vulnerability reporting.
  • Modified the release note generation step in .github/workflows/powershell-build-module.yml to fetch the previous tag correctly by skipping the most recent tag when sorting tags.# Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring
  • Performance improvement
  • Test improvement

Semantic Versioning

  • +semver: major - Breaking changes (1.0.0 → 2.0.0)
  • +semver: minor - New features (1.0.0 → 1.1.0)
  • +semver: patch - Bug fixes (1.0.0 → 1.0.1)
  • +semver: none - No version change (documentation, tests)

Checklist

Code Quality

  • Code follows PowerShell best practices and approved verbs
  • All functions include [CmdletBinding()] attribute
  • Parameter validation attributes are used appropriately
  • Proper error handling with try/catch blocks is implemented
  • Verbose output is provided for troubleshooting
  • No hard-coded paths, credentials, or sensitive data

Testing

  • All new functions have corresponding .Tests.ps1 files
  • Existing tests pass: Invoke-Build Test
  • New tests added for new functionality
  • Code coverage is adequate
  • Edge cases are tested (null/empty inputs)

Code Analysis

  • PSScriptAnalyzer passes: Invoke-Build Invoke-PSScriptAnalyzer
  • No new PSScriptAnalyzer warnings introduced
  • Security checks pass (InjectionHunter tests)

Documentation

  • Comment-based help is complete and accurate
  • Markdown help files updated (if function signatures changed)
  • Examples included in help documentation
  • README.md updated (if applicable)
  • CHANGELOG.md updated (if applicable)

Module Manifest

  • New public functions added to FunctionsToExport in .psd1
  • Module manifest version updated (if applicable)

Related Issues

Closes #

Additional Notes

@marko-stanojevic marko-stanojevic self-assigned this Jan 2, 2026
@marko-stanojevic marko-stanojevic added the enhancement New feature or request label Jan 2, 2026
@marko-stanojevic marko-stanojevic merged commit 0a107aa into main Jan 2, 2026
1 check passed
@marko-stanojevic marko-stanojevic deleted the feature/issue_template branch January 2, 2026 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant