Skip to content

Update PR template#473

Merged
jakmro merged 6 commits intosoftware-mansion:mainfrom
msluszniak:@ms/update-pr-template
Jul 30, 2025
Merged

Update PR template#473
jakmro merged 6 commits intosoftware-mansion:mainfrom
msluszniak:@ms/update-pr-template

Conversation

@msluszniak
Copy link
Copy Markdown
Member

@msluszniak msluszniak commented Jul 27, 2025

Description

This PR adds the following:

  • Clear separation for breaking and non-breaking changes.
  • Another type of changes called Other for new test cases, general code style improvements etc.
  • Remove Both Android and iOS option from bug template since now there is an option to select both Android and iOS which overlaps this option

Type of change

  • 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 (improves or adds clarity to existing documentation)

Tested on

  • iOS
  • Android

Testing instructions

Screenshots

Related issues

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

Additional notes

Separate breaking change into separate subsection and add `Other` type of change for test cases, code style improvements and similar.
Remove option `Both Android and iOS` since you can select both Android and iOS option which will overlap with this option.
Remove Title case to conform with the previous style
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md Outdated
msluszniak and others added 2 commits July 30, 2025 08:00
Co-authored-by: Jakub Mroz <115979017+jakmro@users.noreply.github.com>
Co-authored-by: Jakub Mroz <115979017+jakmro@users.noreply.github.com>
Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md
@msluszniak msluszniak requested a review from jakmro July 30, 2025 06:18
@jakmro jakmro merged commit ffc1b4e into software-mansion:main Jul 30, 2025
2 checks passed
@msluszniak msluszniak deleted the @ms/update-pr-template branch July 30, 2025 06:25
mkopcins pushed a commit that referenced this pull request Oct 15, 2025
## Description

This PR adds the following:
* Clear separation for breaking and non-breaking changes.
* Another type of changes called `Other` for new test cases, general
code style improvements etc.
* Remove `Both Android and iOS` option from bug template since now there
is an option to select both Android and iOS which overlaps this option

### Type of change

- [ ] 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)
- [x] Documentation update (improves or adds clarity to existing
documentation)

### Tested on

- [ ] iOS
- [ ] Android

### Testing instructions

<!-- Provide step-by-step instructions on how to test your changes.
Include setup details if necessary. -->

### Screenshots

<!-- Add screenshots here, if applicable -->

### Related issues

<!-- Link related issues here using #issue-number -->

### Checklist

- [x] I have performed a self-review of my code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have updated the documentation accordingly
- [x] My changes generate no new warnings

### Additional notes

<!-- Include any additional information, assumptions, or context that
reviewers might need to understand this PR. -->

---------

Co-authored-by: Jakub Mroz <115979017+jakmro@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants