Skip to content

Commit

Permalink
Create pull_request_template.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bitshifter authored Jan 29, 2025
1 parent 98af4ea commit c216728
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Objective

- Describe the objective or issue this PR addresses.
- If you're fixing a specific issue, say "Fixes #X".

## Solution

- Describe the solution used to achieve the objective above.

## Code generation

- Most code in glam is generated by an offline tool.
- Are you modify generated code?
- Have you modified the templates and run the code generator?

See https://github.com/bitshifter/glam-rs/blob/main/codegen/README.md for details.

## Testing and linting

- Your PR should include tests for any bug fixes or new features.
- `cargo test` and `cargo clippy` must pass.

You can run most of glam's tests locally by running the `build_and_test_features.sh` script.

## Breaking changes

*This section is optional. If there are no breaking changes, you can delete this section.*

- If this PR is a breaking change describe how a user might need to migrate their code.
- Simply adding new functionality is not a breaking change.
- Fixing behavior that was definitely a bug is not a breaking change.

0 comments on commit c216728

Please sign in to comment.