Skip to content
Draft
Changes from all 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
42 changes: 23 additions & 19 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
### Requirements for Contributing a Bug Fix or Enhancement
* Fill out the template below. Any pull request that does not include enough information to be reviewed in timely manner will result in a request for you to update the pull request
and possibly closure of the pull request if it is not provided after this request.
* After you create the pull request, all status checks must pass before a maintainer will review your contribution.

- Fill out the template below. Any pull request that does not include enough information to be reviewed in timely manner will result in a request for you to update the pull request
and possibly closure of the pull request if it is not provided after this request.
- After you create the pull request, all status checks must pass before a maintainer will review your contribution.

### Identify the Bug or Feature request

<!--
Link to the issue describing the bug of feature request.

Expand All @@ -19,7 +20,6 @@ or if none of those are relevant you can manually link the pull request to an is
see https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue for more information.
-->


### Description of the Change

<!--
Expand All @@ -28,27 +28,31 @@ We must be able to understand the design of your change from this description. I

-->


### Possible Drawbacks

<!-- What are the possible side-effects or negative impacts of the code change? -->
<!-- What are the possible side-effects or negative impacts of the code change? If there are any changes that break backwards compatibility be sure to list them here-->

### Documentation Notes
<!-- Add any information that will help with documentation/explaining the bug fix/new feature to users, include screen shots or animated GIFs where possible -->

### Release Notes

<!--

Please describe the changes in a single line that explains this improvement in
terms that a user can understand. This text will be used in MapTools's release notes.

If this change is not user-facing or notable enough to be included in release notes
you may use the strings "Not applicable" or "N/A" here.
<!-- Add any information that will help with documentation/explaining the bug fix/new feature to users, include screen shots or animated GIFs where possible -->

Examples:
### Checklist

- Fixed an issue where `getMapVisible()` returned strings instead of numbers
- Added the option for overriding players name in token speech/thought bubble.
<!-- You can use a x in the square brackets to indicate indicate the checkbox below is checked, e.g. [x] -->

- [ ] JavaDoc Updated
<!--
Please ensure that any new methods or classes have JavaDoc comments added to them.
If you modified existing methods or classes, please ensure that the JavaDoc comments are still accurate.
It would also be helpful if you could add JavaDoc to any methods or classes in files that you have modified if they do not already have it, and you know what the method or class does.
-->
- [ ] Unit tests
<!--
Added unit tests for new methods and classes (excluding GUI code).
Updated existing unit tests to cover any changes made to existing methods and classes.
It would also be helpful if you could add unit tests for any methods or classes in files that you have modified if they do not already have it, and you know what the method or class does.
-->
- [ ] Is this breaking change?
<!--
If this is a breaking change, please indicate how it is breaking and what the impact is on users in the Possible Drawbacks section above.
-->