Skip to content

Commit 50c590b

Browse files
committed
Create PULL_REQUEST_TEMPLATE.md
1 parent 4829ab3 commit 50c590b

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Pull Request
2+
3+
Thank you for contributing to Text Extractor! Please complete this template to help us review your changes efficiently. Ensure your submission complies with our Contributing Guidelines, Code of Conduct, and Security Policy. Do not include unverified links or promotional content, as they will be considered spam.
4+
5+
## Description
6+
7+
Describe your changes in detail. What problem does this solve, or what feature does it add?
8+
9+
## Related Issue
10+
11+
Link to the issue this PR addresses, if applicable (e.g., `Fixes #123`).
12+
13+
## Type of Change
14+
15+
- \[ \] Bug fix (non-breaking change that fixes an issue)
16+
- \[ \] New feature (non-breaking change that adds functionality)
17+
- \[ \] Breaking change (fix or feature that changes existing functionality)
18+
- \[ \] Documentation update
19+
- \[ \] Security fix
20+
- \[ \] Other (please describe):
21+
22+
## How Has This Been Tested?
23+
24+
Describe how you tested your changes, including:
25+
26+
- Platforms tested (e.g., Windows, macOS, Linux).
27+
- Python version (e.g., 3.9.5).
28+
- Briefcase command used (e.g., `briefcase run windows`).
29+
- Specific scenarios (e.g., downloading a post, UI interaction).
30+
- Any automated tests added or updated.
31+
32+
## Checklist
33+
34+
- \[ \] My code follows the Contributing Guidelines and Code of Conduct.
35+
- \[ \] My changes adhere to PEP 8 style guidelines.
36+
- \[ \] I have tested my changes thoroughly using Briefcase on at least one supported platform.
37+
- \[ \] I have updated the documentation (e.g., `README.md`, `SUPPORT.md`, in-app Help tab) if necessary.
38+
- \[ \] My changes do not introduce new dependencies without prior discussion.
39+
- \[ \] I have not included unverified links or promotional content.
40+
- \[ \] For security-related changes, I have followed the Security Policy.
41+
42+
## Screenshots or Logs (if applicable)
43+
44+
If your changes affect the UI or produce specific outputs, attach screenshots or logs to demonstrate the results.
45+
46+
## Additional Notes
47+
48+
Provide any other context, such as challenges faced, trade-offs made, or future work needed.
49+
50+
---
51+
52+
**Note**: Maintainers may request changes or additional information. Please respond promptly to feedback to ensure a smooth review process.

0 commit comments

Comments
 (0)