From cd530a728585d6f039503ee9f2c601a4e4427e8e Mon Sep 17 00:00:00 2001 From: Jeremy Combs Date: Sun, 18 Jan 2026 12:40:50 -0500 Subject: [PATCH] docs: streamline GitHub templates and remove emojis - Remove all emoji characters from issue and PR templates - Remove emojis from issue template config.yml - Simplify bug report template (84 -> 54 lines) - Simplify feature request template (94 -> 63 lines) - Simplify PR template (180 -> 97 lines) - Consolidate redundant sections and verbose instructions - Maintain all essential fields for proper tracking - Preserve markdown linting compliance (MD032, MD040, MD031, MD024, MD036) --- .github/ISSUE_TEMPLATE/bug_report.md | 70 ++++------ .github/ISSUE_TEMPLATE/config.yml | 6 +- .github/ISSUE_TEMPLATE/feature_request.md | 82 ++++-------- .github/pull_request_template.md | 152 +++++++--------------- 4 files changed, 99 insertions(+), 211 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 103db2b..6039c20 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,75 +6,49 @@ labels: ['bug', 'needs-triage'] assignees: '' --- -## Bug Description +## Description -**Describe the bug** -A clear and concise description of what the bug is. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Actual behavior** -A clear and concise description of what actually happened. +Describe what the bug is and what you expected to happen. ## Reproduction Steps -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. Step 1 +2. Step 2 +3. Step 3 -**Minimal reproducible example** -If applicable, provide the smallest possible example that demonstrates the issue: +**Example:** ```bash -# Example commands or code that reproduce the issue docker run -it jmcombs/powershell ``` ## Environment -**System Information:** -- OS: [e.g. Ubuntu 22.04, macOS 13.0, Windows 11] -- Architecture: [e.g. x64, arm64, arm] +- OS: [e.g. Ubuntu 22.04] +- Architecture: [e.g. x64, arm64] - Docker version: [e.g. 24.0.7] -- Container version/tag: [e.g. latest, specific commit hash] +- Container version: [e.g. latest] -**Script/Component affected:** -- [ ] Docker container runtime -- [ ] Version detection script (`get-net-pwsh-versions.sh`) +**Component:** + +- [ ] Docker container +- [ ] Version detection script - [ ] CI/CD pipeline - [ ] Documentation - [ ] Other: ___________ -## Additional Context +## Logs -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Logs** -If applicable, add relevant log output: - -``` -Paste log output here +```text +Paste relevant log output here ``` -**Additional context** -Add any other context about the problem here. - -## Checklist - -- [ ] I have searched existing issues to ensure this is not a duplicate -- [ ] I have provided all requested information above -- [ ] I have tested with the latest version -- [ ] I have included steps to reproduce the issue - -## Possible Solution +## Additional Context -If you have ideas on how to fix the issue, please describe them here (optional). +Add screenshots, error messages, or other relevant information. ---- +## Checklist -**Note**: Please use the preview tab to ensure your issue is formatted correctly before submitting. +- [ ] Searched existing issues for duplicates +- [ ] Tested with the latest version +- [ ] Provided reproduction steps diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 39fe715..17edadf 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,11 @@ blank_issues_enabled: false contact_links: - - name: ๐Ÿ“š Documentation + - name: Documentation url: https://github.com/jmcombs/powershell/blob/main/README.md about: Check the README for usage instructions and information - - name: ๐Ÿ’ฌ Discussions + - name: Discussions url: https://github.com/jmcombs/powershell/discussions about: Ask questions and discuss ideas with the community - - name: ๐Ÿณ Docker Hub + - name: Docker Hub url: https://hub.docker.com/r/jmcombs/powershell about: View the container on Docker Hub for usage examples and information diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c087573..7b3b94d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,84 +6,58 @@ labels: ['enhancement', 'needs-triage'] assignees: '' --- -## Feature Summary +## Description -**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 feature and the problem it solves. -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +## Use Case -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +Explain the specific scenario where this feature would be beneficial. -## Detailed Description +## Proposed Solution -**Use Case** -Describe the specific use case or scenario where this feature would be beneficial: +Describe how you envision this feature working. -**Proposed Implementation** -If you have ideas on how this could be implemented, please describe them: +## Alternatives Considered -**API/Interface Changes** -If this feature would require changes to existing APIs or interfaces, describe them: +List any alternative solutions you've thought about. -## Impact Assessment +## Impact -**Breaking Changes** -- [ ] This feature would introduce breaking changes -- [ ] This feature is backward compatible -- [ ] Unsure about compatibility impact +**Breaking Changes:** + +- [ ] Introduces breaking changes +- [ ] Backward compatible +- [ ] Unsure + +**Components Affected:** -**Components Affected** - [ ] Docker container - [ ] Version detection script - [ ] CI/CD pipeline - [ ] Documentation -- [ ] Testing framework - [ ] Other: ___________ -**Priority Level** -- [ ] Critical (blocking current functionality) -- [ ] High (significantly improves user experience) -- [ ] Medium (nice to have improvement) -- [ ] Low (minor enhancement) - -## Additional Context - -**Screenshots/Mockups** -If applicable, add screenshots, mockups, or diagrams to help explain your feature request. - -**Related Issues** -Link any related issues or discussions: -- Fixes # -- Related to # -- Depends on # +**Priority:** -**External References** -If this feature is inspired by or similar to functionality in other projects, please provide links: - -**Additional context** -Add any other context, considerations, or requirements about the feature request here. +- [ ] Critical +- [ ] High +- [ ] Medium +- [ ] Low ## Acceptance Criteria -Please define what would make this feature request complete: - - [ ] Criterion 1 - [ ] Criterion 2 -- [ ] Criterion 3 - [ ] Documentation updated -- [ ] Tests added/updated -- [ ] Backward compatibility maintained (if applicable) +- [ ] Tests added -## Checklist +## Additional Context -- [ ] I have searched existing issues to ensure this is not a duplicate -- [ ] I have provided a clear description of the feature -- [ ] I have considered the impact on existing functionality -- [ ] I have defined clear acceptance criteria +Add screenshots, mockups, related issues, or external references. ---- +## Checklist -**Note**: Feature requests will be reviewed and prioritized based on community interest, implementation complexity, and alignment with project goals. +- [ ] Searched existing issues for duplicates +- [ ] Provided clear description and use case +- [ ] Defined acceptance criteria diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ba66142..8083847 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,156 +2,96 @@ ## Description -**Summary of Changes** -Provide a clear and concise description of what this PR does. +Provide a clear description of what this PR does. + +**Related Issues:** -**Related Issues** - Fixes #(issue number) -- Closes #(issue number) - Related to #(issue number) -**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 -- [ ] ๐Ÿงช Test improvements -- [ ] ๐Ÿ”ง CI/CD improvements -- [ ] โ™ป๏ธ Code refactoring (no functional changes) - -## Changes Made - -**Detailed Description** -Explain the changes in detail. Include: -- What was changed and why -- How the solution works -- Any design decisions made - -**Files Modified** -- [ ] `scripts/get-net-pwsh-versions.sh` -- [ ] `Dockerfile` -- [ ] `.github/workflows/ci.yml` -- [ ] `.github/workflows/test.yml` -- [ ] `README.md` -- [ ] `CONTRIBUTING.md` -- [ ] Test files -- [ ] Other: ___________ +**Type of Change:** + +- [ ] Bug fix (non-breaking) +- [ ] New feature (non-breaking) +- [ ] Breaking change +- [ ] Documentation update +- [ ] Test improvements +- [ ] CI/CD improvements +- [ ] Code refactoring + +## Changes + +Explain what was changed and why: + +- Key change 1 +- Key change 2 +- Key change 3 ## Testing -**Test Coverage** +**Test Coverage:** + - [ ] Unit tests added/updated - [ ] Integration tests added/updated -- [ ] Manual testing completed -- [ ] All existing tests pass +- [ ] All tests pass + +**Test Results:** -**Test Results** ```bash -# Paste test output here $ bats tests/ -โœ“ test 1 -โœ“ test 2 -... +# Paste test output here ``` -**Manual Testing Steps** +**Manual Testing:** + 1. Step 1 2. Step 2 -3. Step 3 -**Test Environment** +**Environment:** + - OS: [e.g. Ubuntu 22.04] - Docker version: [e.g. 24.0.7] - Architecture: [e.g. x64] -## Quality Assurance +## Quality Checks -**Code Quality** - [ ] Code follows project style guidelines - [ ] Scripts pass shellcheck validation -- [ ] No new warnings or errors introduced +- [ ] No new warnings or errors - [ ] Code is properly commented - -**Security** - [ ] No sensitive information exposed -- [ ] No new security vulnerabilities introduced -- [ ] Dependencies are up to date and secure - -**Performance** +- [ ] No security vulnerabilities introduced - [ ] No performance regressions -- [ ] Changes are optimized where possible -- [ ] Resource usage is reasonable ## Documentation -**Documentation Updates** - [ ] README.md updated (if needed) - [ ] CONTRIBUTING.md updated (if needed) -- [ ] Inline code comments added/updated -- [ ] API documentation updated (if applicable) - -**Breaking Changes Documentation** -If this PR introduces breaking changes, describe: -- What breaks -- How to migrate -- Timeline for deprecation (if applicable) +- [ ] Code comments added/updated +- [ ] Breaking changes documented (if applicable) ## Deployment -**Deployment Considerations** - [ ] Changes are backward compatible -- [ ] No database migrations required -- [ ] No configuration changes required - [ ] CI/CD pipeline updated (if needed) -**Rollback Plan** -If something goes wrong, how can this change be rolled back? +**Rollback Plan:** -## Screenshots/Logs +Describe how to rollback if needed. -**Before/After Comparison** -If applicable, add screenshots or log outputs showing the before and after state. +## Screenshots -**Visual Changes** -If this PR affects the user interface or output, include screenshots. +Add before/after screenshots if applicable. ## Checklist -**Pre-submission** -- [ ] I have performed a self-review of my code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes - -**Testing** -- [ ] I have tested the changes locally -- [ ] I have run the full test suite -- [ ] I have tested on multiple architectures (if applicable) -- [ ] I have tested the Docker container build process - -**Documentation** -- [ ] I have updated relevant documentation -- [ ] I have added appropriate comments to the code -- [ ] I have updated the changelog (if applicable) - -**Review Ready** -- [ ] This PR is ready for review -- [ ] I have addressed all feedback from previous reviews -- [ ] I have resolved all merge conflicts +- [ ] Self-reviewed my code +- [ ] Added/updated tests +- [ ] Updated documentation +- [ ] All tests pass locally +- [ ] Resolved merge conflicts +- [ ] Ready for review ## Additional Notes -**Reviewer Notes** -Any specific areas you'd like reviewers to focus on? - -**Future Work** -Any follow-up work that should be done in future PRs? - -**Dependencies** -Any external dependencies or requirements for this change? - ---- - -**Note**: Please ensure all checkboxes are completed before requesting review. Use the preview tab to verify formatting. +Any specific areas for reviewers to focus on or future work planned.