|
| 1 | + |
| 2 | +*** |
| 3 | + |
| 4 | +# Creating a pull request |
| 5 | + |
| 6 | +Thank you for taking the time to create a pull request in this repository! Please fill out this form before submitting your PR. |
| 7 | + |
| 8 | +**Note:** you can change the language of the formatting if needed, but it must be valid syntax. Supported languages include: ASCIIDoc, Org mode, Markdown, WikiText, ReStructuredText, Creole, Pod, RDoc, Textile, and plain text. Be sure to change thw `markdown` tag to the appropriate language. |
| 9 | + |
| 10 | +Provide a general summary of your changes in the Title above |
| 11 | + |
| 12 | +```markdown |
| 13 | +Your summary description (title) goes here |
| 14 | +``` |
| 15 | + |
| 16 | +## Description |
| 17 | + |
| 18 | +Describe your changes in detail |
| 19 | + |
| 20 | +```markdown |
| 21 | +Your issue description (body) goes here |
| 22 | +``` |
| 23 | + |
| 24 | +## Related Issue |
| 25 | + |
| 26 | +- [ ] This project only accepts pull requests related to open issues |
| 27 | +- [ ] If suggesting a new feature or change, please discuss it in an issue first |
| 28 | +- [ ] If fixing a bug, there should be an issue describing it with steps to reproduce |
| 29 | +- [ ] Please link to the issue here: |
| 30 | + |
| 31 | +```markdown |
| 32 | +Link to the issue here, #__ |
| 33 | +``` |
| 34 | + |
| 35 | +## Motivation and Context |
| 36 | + |
| 37 | +Why is this change required? What problem does it solve? |
| 38 | + |
| 39 | +```markdown |
| 40 | + |
| 41 | +``` |
| 42 | + |
| 43 | +## How Has This Been Tested? |
| 44 | + |
| 45 | +- [ ] Please describe in detail how you tested your changes. |
| 46 | +- [ ] Include details of your testing environment, and the tests you ran to. |
| 47 | +- [ ] see how your change affects other areas of the code, etc. |
| 48 | + |
| 49 | +## Screenshots (if appropriate): |
| 50 | + |
| 51 | +Please include the screenshots inside your pull request as well as a local link (hard copy) |
| 52 | + |
| 53 | +**Warning:** `.webp` and `.heif` images are not accepted. Please convert them to a different format (such as PNG, JPG, JPEG, JIF, GIF, TIF, etc.) |
| 54 | + |
| 55 | +**Warning:** Images outside of `/.github/Pull_Requests/Queue/PR/` are not accepted, and will be removed from the PR within 24 hours if not fixed |
| 56 | + |
| 57 | +```markdown |
| 58 | +Remove this section, and only include the links if you use this section. Be sure to delete image fields that are not needed. Max screenshots per PR: 5. Also, if screenshots aren't necessary, please delete this entire section |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | +``` |
| 66 | + |
| 67 | +## Types of changes |
| 68 | + |
| 69 | +What types of changes does your code introduce? Put an `x` in all the boxes that apply: |
| 70 | + |
| 71 | +- [ ] Bug fix (non-breaking change which fixes an issue) |
| 72 | +- [ ] New feature (non-breaking change which adds functionality) |
| 73 | +- [ ] Breaking change (fix or feature that would cause existing functionality to change) |
| 74 | + |
| 75 | +## Checklist: |
| 76 | + |
| 77 | +Go over all the following points, and put an `x` in all the boxes that apply. |
| 78 | + |
| 79 | +If you're unsure about any of these, don't hesitate to ask. We're here to help! |
| 80 | + |
| 81 | +- [ ] My source code (if source code is provided) follows the source code style of this project. |
| 82 | +- [ ] My change requires a change to the documentation. |
| 83 | +- [ ] My change does not delete necessary files |
| 84 | +- [ ] I have updated the documentation accordingly. |
| 85 | +- [ ] I have read the [**`CONTRIBUTING`**](/CONTRIBUTING.md) document in my spoken language, and understand the terms |
| 86 | +- [ ] I have added tests to cover my changes. |
| 87 | +- [ ] I have gone through all the steps, and have thoroughly read the instructions |
| 88 | + |
| 89 | +*** |
| 90 | + |
| 91 | +<!-- Template info |
| 92 | +
|
| 93 | +Pull request template |
| 94 | +
|
| 95 | +Version 1 (2022, Thursday, May 19th at 5:47 pm PST) |
| 96 | +
|
| 97 | +File type: Markdown document (*.md *.mkd *.mdown *.markdown) |
| 98 | +
|
| 99 | +Line count (including blank lines and compiler line): 102 |
| 100 | +
|
| 101 | +!--> |
0 commit comments