Skip to content

Commit 3ebece9

Browse files
committed
Update pull request template for CFDI project relevance
- Replace generic template with project-specific sections - Add CFDI version support and PAC integration change types - Add CFDI/SAT impact section for affected versions and complements - Replace firmware/hardware test config with Python version and pytest - Streamline checklist with SAT schema compliance check
1 parent a77f268 commit 3ebece9

1 file changed

Lines changed: 21 additions & 25 deletions

File tree

.github/pull_request_template.md

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,37 @@
1-
# Pull Request Template
2-
31
## Description
42

5-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
3+
Brief summary of the change and its motivation.
64

75
Fixes # (issue)
86

97
## Type of change
108

11-
Please delete options that are not relevant.
12-
139
- [ ] Bug fix (non-breaking change which fixes an issue)
1410
- [ ] New feature (non-breaking change which adds functionality)
1511
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16-
- [ ] This change requires a documentation update
12+
- [ ] CFDI version support (new complement, addenda, or catalog update)
13+
- [ ] PAC integration (new or updated provider)
14+
- [ ] Documentation update
15+
16+
## CFDI / SAT impact
17+
18+
<!-- Delete this section if not applicable -->
1719

18-
## How Has This Been Tested?
20+
- **Affected CFDI versions**: (e.g., 4.0, 3.3, Retenciones 2.0)
21+
- **Affected complements**: (e.g., Nomina, Pagos, TimbreFiscalDigital)
22+
- **SAT catalog changes**: Yes / No
1923

20-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
24+
## How has this been tested?
2125

22-
- [ ] Test A
23-
- [ ] Test B
26+
- [ ] `pytest tests/` passes locally
27+
- [ ] Tested with sample XML files
28+
- [ ] Verified PDF/HTML rendering output
2429

25-
**Test Configuration**:
26-
* Firmware version:
27-
* Hardware:
28-
* Toolchain:
29-
* SDK:
30+
**Python version(s) tested**: (e.g., 3.11, 3.13)
3031

31-
## Checklist:
32+
## Checklist
3233

33-
- [ ] My code follows the style guidelines of this project
34-
- [ ] I have performed a self-review of my own code
35-
- [ ] I have commented my code, particularly in hard-to-understand areas
36-
- [ ] I have made corresponding changes to the documentation
37-
- [ ] My changes generate no new warnings
38-
- [ ] I have added tests that prove my fix is effective or that my feature works
39-
- [ ] New and existing unit tests pass locally with my changes
40-
- [ ] Any dependent changes have been merged and published in downstream modules
41-
- [ ] I have checked my code and corrected any misspellings
34+
- [ ] I have performed a self-review of my code
35+
- [ ] XML output matches SAT schema requirements (if applicable)
36+
- [ ] New and existing tests pass locally
37+
- [ ] I have updated documentation (if applicable)

0 commit comments

Comments
 (0)