docs: add new PR template to standardise contributions#125
Open
liamchampton wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new GitHub Pull Request template to standardize contributor submissions and improve review quality/consistency.
Changes:
- Introduces a structured PR template with sections for description, related issues, change type, affected areas, testing, and screenshots/output.
- Adds an explicit checklist aligned with project expectations (linting, GoDoc, function size, float32 STL output, docs updates).
Show a summary per file
| File | Description |
|---|---|
| .github/PULL_REQUEST_TEMPLATE.md | Adds a standardized PR template to guide contributors through required context, testing, and project conventions. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 1
| - [ ] Functions are focused and reasonably sized (generally under 50 lines) | ||
| - [ ] Final STL output uses `float32` to adhere to the STL format (if applicable) | ||
| - [ ] I have updated the README / docs where relevant (new flags, behavior changes, etc.) | ||
| - [ ] I have read the [Contributing guide](../CONTRIBUTING.md) and [Code of Conduct](../CODE_OF_CONDUCT.md) |
There was a problem hiding this comment.
The checklist links use ../CONTRIBUTING.md and ../CODE_OF_CONDUCT.md. Since this template is inserted into the PR body (not rendered as a file in a directory), ../ links can resolve incorrectly on GitHub. Prefer repo-root relative links like CONTRIBUTING.md / CODE_OF_CONDUCT.md (or /CONTRIBUTING.md / /CODE_OF_CONDUCT.md) so they work reliably from PRs/issues.
Suggested change
| - [ ] I have read the [Contributing guide](../CONTRIBUTING.md) and [Code of Conduct](../CODE_OF_CONDUCT.md) | |
| - [ ] I have read the [Contributing guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a new PR template