From 1a6454d4b525b35d0278daf5dda0587afea849c6 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Thu, 9 Jul 2026 00:51:07 +0300 Subject: [PATCH 1/3] feat: add issue and PR templates Added org-wide default templates for all cpp-linter repositories: - .github/ISSUE_TEMPLATE/bug_report.md - structured bug reporting - .github/ISSUE_TEMPLATE/feature_request.md - feature request template - .github/PULL_REQUEST_TEMPLATE.md - PR description checklist --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 27 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 27 +++++++++++++++++++ 3 files changed, 86 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..593a3dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug Report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Run command '...' +2. With arguments '...' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots / Logs** +If applicable, add screenshots or relevant log output to help explain your problem. + +**Environment (please complete the following information):** +- OS: [e.g. Ubuntu 22.04, macOS 14] +- cpp-linter version: [e.g. 2.0.0] +- Python version: [e.g. 3.11] +- Git version: [e.g. 2.40] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..ece0670 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**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 solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Usage example** +If applicable, show how this feature would be used: + +```yaml +# Example configuration or command +``` + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ae12cc0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +## Summary + + + +## Related Issues + + + +## Type of Change + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would break existing functionality) +- [ ] Documentation update +- [ ] Chore (refactor, dependency updates, CI config, etc.) + +## Checklist + +- [ ] I have read the [contributing guidelines](https://github.com/cpp-linter/.github/blob/main/CONTRIBUTING.md) (if applicable) +- [ ] My changes follow the project's coding style +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing tests pass locally +- [ ] I have updated the documentation accordingly + +## Additional Context + + From e37c49663ade25cd58573746293e0a71b2b75c92 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Thu, 9 Jul 2026 00:54:41 +0300 Subject: [PATCH 2/3] chore: simplify PR template to bare minimum --- .github/PULL_REQUEST_TEMPLATE.md | 24 ++---------------------- 1 file changed, 2 insertions(+), 22 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ae12cc0..8963d76 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,27 +1,7 @@ ## Summary - + ## Related Issues - - -## Type of Change - -- [ ] Bug fix (non-breaking change that fixes an issue) -- [ ] New feature (non-breaking change that adds functionality) -- [ ] Breaking change (fix or feature that would break existing functionality) -- [ ] Documentation update -- [ ] Chore (refactor, dependency updates, CI config, etc.) - -## Checklist - -- [ ] I have read the [contributing guidelines](https://github.com/cpp-linter/.github/blob/main/CONTRIBUTING.md) (if applicable) -- [ ] My changes follow the project's coding style -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing tests pass locally -- [ ] I have updated the documentation accordingly - -## Additional Context - - + From 6f732c5646997eb331a87316a0354509e6c51c61 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Thu, 9 Jul 2026 00:56:16 +0300 Subject: [PATCH 3/3] chore: simplify issue templates, make org-wide --- .github/ISSUE_TEMPLATE/bug_report.md | 23 ++++++++--------------- .github/ISSUE_TEMPLATE/feature_request.md | 21 +++++++-------------- 2 files changed, 15 insertions(+), 29 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 593a3dd..2401d02 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug Report -about: Create a report to help us improve +about: Report a bug to help us improve title: '' labels: bug assignees: '' @@ -11,22 +11,15 @@ assignees: '' A clear and concise description of what the bug is. **To Reproduce** -Steps to reproduce the behavior: -1. Run command '...' -2. With arguments '...' -3. See error +Steps to reproduce the behavior. **Expected behavior** -A clear and concise description of what you expected to happen. +What you expected to happen instead. -**Screenshots / Logs** -If applicable, add screenshots or relevant log output to help explain your problem. - -**Environment (please complete the following information):** -- OS: [e.g. Ubuntu 22.04, macOS 14] -- cpp-linter version: [e.g. 2.0.0] -- Python version: [e.g. 3.11] -- Git version: [e.g. 2.40] +**Environment** +- OS: +- Project version: +- Relevant tool/CLI version: **Additional context** -Add any other context about the problem here. +Add any other context, logs, or screenshots. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index ece0670..80935f6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,21 +7,14 @@ assignees: '' --- -**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 [...] +**Problem** +What problem does this solve? -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +**Solution** +What would you like to happen? -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Usage example** -If applicable, show how this feature would be used: - -```yaml -# Example configuration or command -``` +**Alternatives** +Any alternative solutions you've considered. **Additional context** -Add any other context or screenshots about the feature request here. +Add any other context or examples.