|
| 1 | +name: Pull Request |
| 2 | +description: Submit a pull request |
| 3 | +title: "[Type of Change]: [Brief Description]" |
| 4 | +body: |
| 5 | + - type: dropdown |
| 6 | + id: change-type |
| 7 | + attributes: |
| 8 | + label: Type of Change |
| 9 | + options: |
| 10 | + - New notebook |
| 11 | + - Notebook update |
| 12 | + - Documentation update |
| 13 | + - Environment/dependency update |
| 14 | + - Other |
| 15 | + validations: |
| 16 | + required: true |
| 17 | + - type: textarea |
| 18 | + id: description |
| 19 | + attributes: |
| 20 | + label: Description |
| 21 | + description: What changes does this PR make? |
| 22 | + validations: |
| 23 | + required: true |
| 24 | + - type: textarea |
| 25 | + id: testing |
| 26 | + attributes: |
| 27 | + label: Testing |
| 28 | + description: | |
| 29 | + How have you verified these changes work? |
| 30 | + For notebooks: |
| 31 | + - Include a screen recording showing execution and outputs |
| 32 | + - Or include screenshots of key outputs with explanation |
| 33 | + |
| 34 | + For documentation: |
| 35 | + - Preview any markdown changes |
| 36 | + - Test any new links or references |
| 37 | + validations: |
| 38 | + required: true |
| 39 | + - type: checkboxes |
| 40 | + id: notebook-checklist |
| 41 | + attributes: |
| 42 | + label: Notebook Changes Checklist |
| 43 | + description: Complete this section if you're modifying notebooks |
| 44 | + options: |
| 45 | + - label: I have run the notebook from start to finish without errors |
| 46 | + - label: I have cleared all cell outputs before committing |
| 47 | + - label: I have included all required pip installations with pinned versions (e.g., pip install package==1.2.3) in %%sh cells at the start of the notebook |
| 48 | + - label: I have included a screen recording or screenshots demonstrating the changes |
| 49 | + - label: I have added sufficient markdown cells to explain the notebook's purpose and usage |
| 50 | + validations: |
| 51 | + required: false |
| 52 | + - type: checkboxes |
| 53 | + id: documentation-checklist |
| 54 | + attributes: |
| 55 | + label: Documentation Changes Checklist |
| 56 | + description: Complete this section if you're modifying documentation |
| 57 | + options: |
| 58 | + - label: I have checked for similar wording/style issues across all documentation |
| 59 | + - label: I have verified all links and references still work |
| 60 | + - label: I have previewed how the changes will appear |
| 61 | + - label: I have followed the repository's documentation style guide (if applicable) |
| 62 | + validations: |
| 63 | + required: false |
| 64 | + - type: input |
| 65 | + id: related-issues |
| 66 | + attributes: |
| 67 | + label: Related Issues |
| 68 | + description: "Add any related issue numbers (e.g., Fixes #123)" |
| 69 | + validations: |
| 70 | + required: false |
| 71 | + - type: markdown |
| 72 | + attributes: |
| 73 | + value: | |
| 74 | + > **Note for notebook submissions:** |
| 75 | + > - Run the notebook in a fresh environment (e.g., new conda env or colab instance) to ensure all dependencies are captured |
| 76 | + > - Comments should explain the purpose of non-obvious code blocks and any external data dependencies |
| 77 | +
|
| 78 | + > **Note for documentation updates:** |
| 79 | + > - For minor changes, consider bundling multiple related improvements in one PR |
| 80 | + > - Look for opportunities to improve similar sections across the documentation |
0 commit comments