Skip to content

Commit f44b04e

Browse files
committed
🛠️ chore(templates): Create issue and pull request templates
1 parent 280b949 commit f44b04e

File tree

4 files changed

+99
-0
lines changed

4 files changed

+99
-0
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
assignees: ''
6+
---
7+
8+
## Describe the bug
9+
A clear and concise description of what the bug is.
10+
11+
## To Reproduce
12+
Steps to reproduce the behavior:
13+
1. CMake configure flags:
14+
2. Build type (Debug/Release):
15+
3. Commands run:
16+
4. Minimal code snippet (if applicable):
17+
18+
## Expected behavior
19+
What you expected to happen.
20+
21+
## Actual behavior / logs
22+
Paste error messages, stack traces, or relevant logs.
23+
24+
## Environment
25+
- OS: Linux (distro + version):
26+
- Kernel version: `uname -r`:
27+
- Compiler and version (e.g., gcc 13, clang 17):
28+
- CMake version: `cmake --version`:
29+
- Doxygen/Sphinx versions (if docs-related):
30+
- `socat` version (if examples-related):
31+
32+
## Additional context
33+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Q&A / Usage questions
4+
url: https://github.com/NestorDP/cppserial/discussions
5+
about: Ask and answer questions, share tips, and propose ideas.
6+
- name: Documentation
7+
url: https://github.com/NestorDP/cppserial#readme
8+
about: Read setup and usage instructions.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
assignees: ''
6+
---
7+
8+
## Problem
9+
What problem are you trying to solve? What’s the user story?
10+
11+
## Proposed solution
12+
Describe the feature and how it should work. Include API shape if applicable.
13+
14+
## Alternatives considered
15+
List alternative solutions or workarounds you’ve considered.
16+
17+
## Impact
18+
- Public API changes? [yes/no]
19+
- Examples/docs updates needed? [yes/no]
20+
21+
## Additional context
22+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Summary
2+
3+
- What does this PR do? Why is it needed?
4+
- Link related issues (e.g., Closes #123)
5+
6+
## Changes
7+
8+
- [ ] API changes
9+
- [ ] Behavior changes
10+
- [ ] Docs updated
11+
- [ ] Tests added/updated
12+
13+
### Details
14+
15+
- Briefly list the key changes and files touched
16+
17+
## How to test
18+
19+
- Commands and steps to validate locally
20+
- Include any environment requirements (Linux only, kernel version, etc.)
21+
22+
## Screenshots/Logs (optional)
23+
24+
- Paste relevant output/logs if helpful
25+
26+
## Checklist
27+
28+
- [ ] Builds locally (Release + Debug)
29+
- [ ] All tests pass (if applicable)
30+
- [ ] Lint/format pass: `make cppcheck` / `make cpplint` / `make uncrustify`
31+
- [ ] Example(s) tested (if touched)
32+
- [ ] Documentation updated (README/docs)
33+
34+
## Risks and rollbacks
35+
36+
- Potential impact areas, and how to revert if needed

0 commit comments

Comments
 (0)