Skip to content

Commit fb8b90a

Browse files
rcap107rcap107
authored
Adding templates for prs (skrub-data#1727)
1 parent e4d5181 commit fb8b90a

4 files changed

Lines changed: 147 additions & 0 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE/bug_fix.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Bug Fix Pull Request
2+
3+
<!--
4+
Before proceeding, please confirm that:
5+
1. The changes have been discussed with the maintainers
6+
2. A plan has been agreed upon
7+
3. The related issue has been assigned to you
8+
-->
9+
10+
## Description
11+
12+
<!-- Please include a summary of the bug fix -->
13+
14+
Fixes #<!-- issue number -->
15+
16+
## Checklist
17+
18+
- [ ] I have read the contributing guidelines
19+
- [ ] I have added tests that verify the bug fix
20+
- [ ] I have added an entry to CHANGES.rst describing the fix
21+
- [ ] My code follows the code style of this project
22+
- [ ] I have checked my code and corrected any misspellings
23+
24+
## How Has This Been Tested?
25+
26+
<!-- Please describe the tests that you ran to verify your changes -->
27+
28+
## Steps to Reproduce (original bug)
29+
30+
<!-- Please provide steps to reproduce the bug you fixed -->
31+
32+
1.
33+
2.
34+
3.
35+
36+
## Additional Notes
37+
38+
<!-- Add any other context about the PR here -->

‎.github/PULL_REQUEST_TEMPLATE/documentation.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Documentation Pull Request
2+
3+
<!--
4+
Before proceeding, please confirm that:
5+
1. The changes have been discussed with the maintainers
6+
2. A plan has been agreed upon
7+
3. The related issue has been assigned to you
8+
-->
9+
10+
## Description
11+
12+
<!-- Please include a summary of the documentation changes -->
13+
14+
Fixes #<!-- issue number -->
15+
16+
## Checklist
17+
18+
- [ ] I have read the contributing guidelines
19+
- [ ] Documentation renders correctly (if applicable)
20+
- [ ] Links are working (if applicable)
21+
- [ ] Code examples are correct and working (if applicable)
22+
- [ ] Spelling and grammar have been checked
23+
- [ ] My changes follow the documentation style of this project
24+
25+
## Type of Documentation Change
26+
27+
- [ ] New documentation
28+
- [ ] Documentation update
29+
- [ ] Typo fix
30+
- [ ] Other (please describe):
31+
32+
## Additional Notes
33+
34+
<!-- Add any other context about the PR here -->

‎.github/PULL_REQUEST_TEMPLATE/feature.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# New Feature Pull Request
2+
3+
<!--
4+
Before proceeding, please confirm that:
5+
1. The changes have been discussed with the maintainers
6+
2. A plan has been agreed upon
7+
3. The related issue has been assigned to you
8+
-->
9+
10+
## Description
11+
12+
<!-- Please include a summary of the new feature -->
13+
14+
Fixes #<!-- issue number -->
15+
16+
## Checklist
17+
18+
- [ ] I have read the contributing guidelines
19+
- [ ] I have added tests that verify the feature works
20+
- [ ] I have added necessary documentation:
21+
- [ ] Docstrings for new functions/classes
22+
- [ ] API documentation if applicable
23+
- [ ] Example notebook or script demonstrating usage
24+
- [ ] I have added an entry to CHANGES.rst describing the feature
25+
- [ ] My code follows the code style of this project
26+
- [ ] I have checked my code and corrected any misspellings
27+
28+
If the feature inherits from `SingleColumnTransformer`:
29+
- [ ] `get_feature_names_out` has been implemented
30+
31+
## How Has This Been Tested?
32+
33+
<!-- Please describe the tests that you ran to verify your changes -->
34+
35+
## Example Usage
36+
37+
<!-- Please provide a minimal example of how to use this feature -->
38+
39+
## Additional Notes
40+
41+
<!-- Add any other context about the PR here -->

‎.github/PULL_REQUEST_TEMPLATE/refactoring.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Refactoring Pull Request
2+
3+
<!--
4+
Before proceeding, please confirm that:
5+
1. The changes have been discussed with the maintainers
6+
2. A plan has been agreed upon
7+
3. The related issue has been assigned to you
8+
-->
9+
10+
## Description
11+
12+
<!-- Please include a summary of the refactoring changes -->
13+
14+
Fixes #<!-- issue number -->
15+
16+
## Checklist
17+
18+
- [ ] I have read the contributing guidelines
19+
- [ ] My changes don't introduce any new features or fix any bugs
20+
- [ ] My code follows the code style of this project
21+
- [ ] I have checked my code and corrected any misspellings
22+
- [ ] Existing tests still pass
23+
24+
## Type of Refactoring
25+
26+
- [ ] Code organization
27+
- [ ] Performance improvement
28+
- [ ] Code cleanup
29+
- [ ] Dependencies update
30+
- [ ] Other (please describe):
31+
32+
## Additional Notes
33+
34+
<!-- Add any other context about the PR here -->

0 commit comments

Comments
 (0)