Pull Request Template
Most SplashKit repos have a default pull request template that you can use. Usage Example PRs will need to use the template below.
See the templates in the tabs below:
Remove the default template in the pull request, and instead, use the following template:
# Description
**Splashkit Function:** `function_name`
**Overview of example functionality:** _Describe the example and how it demonstrates the function._
**Example Output:** _Add an image, or gif (or relevant demo file) of the example code running._
# Files Included
- [ ] C++ code- [ ] C# code (Top-Level statements)- [ ] C# code (Object-Oriented Programming)- [ ] Python code- [ ] Relevant title for the example (.txt)- [ ] Screenshot
# Usage Example Checks (READ CAREFULLY)
- [ ] Code uses Splashkit function above- [ ] Code does not use non-Splashkit functions- [ ] Code does not use extra function declarations or extra classes- [ ] Code does not violate any of the Thoth Tech SplashKit Style Guide rules- [ ] Simple, clear demonstration of the function- [ ] Tested in Chrome and Firefox# Description
_Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change._
## Type of change
_Please delete options that are not relevant._
- [ ] Bug fix (non-breaking change which fixes an issue)- [ ] New feature (non-breaking change which adds functionality)- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)- [ ] Documentation (update or new)
## How Has This Been Tested?
_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._
## Testing Checklist
- [ ] Tested in latest Chrome- [ ] Tested in latest Firefox- [ ] npm run build- [ ] npm run preview
## Checklist
_Please delete options that are not relevant._
### If involving code
- [ ] My code follows the style guidelines of this project- [ ] I have performed a self-review of my own code- [ ] I have commented my code in hard-to-understand areas- [ ] I have made corresponding changes to the documentation- [ ] My changes generate no new warnings
### If modified config files
- [ ] I have checked the following files for changes: - [ ] package.json - [ ] astro.config.mjs - [ ] netlify.toml - [ ] docker-compose.yml - [ ] custom.css
## Folders and Files Added/Modified
_Please list the folders and files added/modified with this pull request and delete options that are not relevant._
- Added: - [ ] folder/folder - [ ] folder/folder- Modified: - [ ] folder/file - [ ] folder/file
## Additional Notes
_Please add any additional information that might be useful for the reviewers._# Description
_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._
Fixes # (issue)
## Type of change
_Please delete options that are not relevant._
- [ ] Bug fix (non-breaking change which fixes an issue)- [ ] New feature (non-breaking change which adds functionality)- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)- [ ] Documentation (update or new)
## How Has This Been Tested?
_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_
## Testing Checklist
- [ ] Tested with sktest- [ ] Tested with skunit_tests
## Checklist
- [ ] My code follows the style guidelines of this project- [ ] I have performed a self-review of my own code- [ ] I have commented my code in hard-to-understand areas- [ ] I have made corresponding changes to the documentation- [ ] My changes generate no new warnings- [ ] I have requested a review from ... on the Pull RequestOnce submitted, move the associated planner card to peer review and link the pull request. Follow the Planner Board Etiquette for more details on the process.