Skip to content
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Description

## Approach

## Motivation

## Checklist before submitting the PR:
- [ ] I've read and followed the [contribution guidelines](https://github.com/PixelGuys/Cubyz/blob/master/docs/CONTRIBUTING.md).
- [ ] I've tested my change thoroughly to ensure I've introduced no regressions.
- [ ] I've added tests where appropriate.
- [ ] I've linked the related issue to this PR either with a "Fixes #12345" or via the github web interface.
11 changes: 11 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,17 @@ Often the simplest code is easier to read, easier to maintain and more efficient
- Use the simplest data structure for the job: e.g. use a slice instead of List if you know the size upfront
- Don't make things public if they don't need to be

## Test your changes

Before you submit changes for review, you should take some time to test your changes.
- Be mindful of the features you have touched by changing the code you've changed. Test those features to ensure there were no regressions.
- We don't expect you to know everything here. But, a little work up front can save review cycles in the future if you may have broken something by mistake.

## Name your PR appropriately

For example, if you're fixing issue #12345, don't name the PR "Fix #12345".
Instead, include that in the description of the PR and name your PR something that better describes the impact of your change (i.e. "Add <biome name here>", "Rebalance tool properties", "Refactor <function name>", etc)

## A note on performance optimizations

I like to follow Casey Muratori's optimization philosophy as outlined here: https://www.youtube.com/watch?v=pgoetgxecw8
Expand Down