Skip to content

Commit 1d2bc71

Browse files
committed
Add merge request templates and contributing.md
1 parent f60934b commit 1d2bc71

File tree

4 files changed

+108
-0
lines changed

4 files changed

+108
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## This Merge Request Template
2+
3+
This merge request template is the default and should be used when contributing any changes to stable packages.
4+
5+
For contributions to pre-release/preview packages use the lightweight merge request template.
6+
7+
For release merge requests, use the release template.
8+
9+
## Summary
10+
11+
_Summary of the purpose of this merge request._
12+
13+
## Contributor Tasks
14+
15+
_These tasks are for the merge request creator to tick off when creating a merge request._
16+
17+
- [ ] Pair review with a member of the QA team.
18+
- [ ] Add any release testing considerations to the MR for the next release.
19+
- [ ] Check any relevant CHANGELOG files have been updated.
20+
- [ ] Ensure documentation requirements are met e.g., public API is commented.
21+
- [ ] Consider any licensing/other legal implications for this MR e.g. notices required by any new libraries.
22+
- [ ] Add any relevant labels such as `breaking` to this MR.
23+
24+
## Reviewer Tasks
25+
26+
_Add any instructions or tasks for the reviewer such as specific test considerations before this can be merged._
27+
28+
[Use emojis in review threads to communicate intent and help contributors.](../../CONTRIBUTING.md#review-threads)
29+
30+
- [ ] Code reviewed.
31+
- [ ] Non-code assets e.g. Unity assets/scenes reviewed.
32+
- [ ] Documentation has been reviewed. Includes checking documentation requirements are met and not missing e.g., public API is commented.
33+
- [ ] Checked and agree with release testing considerations added to MR for the next release.
34+
35+
## Closes JIRA Issue
36+
37+
_If this MR closes any JIRA issues list them below in the form `Closes PROJECT-#`_
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## This Merge Request Template
2+
3+
This merge request template is for contributing to pre-release/preview packages and has fewer tasks to complete. The quality threshold for reviewing these merge requests is lower - prioritize a lean review process.
4+
5+
## Summary
6+
7+
_Summary of the purpose of this merge request._
8+
9+
## Contributor Tasks
10+
11+
_These tasks are for the merge request creator to tick off when creating a merge request._
12+
13+
- [ ] Pair review with a member of the QA team.
14+
- [ ] Add any release testing considerations to the MR for the next release.
15+
- [ ] Consider any licensing/other legal implications for this MR e.g. notices required by any new libraries.
16+
17+
## Reviewer Tasks
18+
19+
_Add any instructions or tasks for the reviewer such as specific test considerations before this can be merged._
20+
21+
[Use emojis in review threads to communicate intent and help contributors.](../../CONTRIBUTING.md#review-threads)
22+
23+
- [ ] Code reviewed.
24+
- [ ] Non-code assets e.g. Unity assets/scenes reviewed.
25+
- [ ] Checked and agree with release testing considerations added to MR for the next release.
26+
27+
## Closes JIRA Issue
28+
29+
_If this MR closes any JIRA issues list them below in the form `Closes PROJECT-#`_
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## This Merge Request Template
2+
3+
This merge request template is for release merge requests.
4+
5+
## Summary
6+
7+
_Summary of the purpose of this merge request._
8+
9+
## Release Tasks
10+
11+
_These tasks are for the merge request creator to tick off when creating a merge request._
12+
13+
- [ ] Run through the pre-release steps on [Confluence](https://ultrahaptics.atlassian.net/wiki/spaces/SV/pages/3665625233). The rest of the process continues after this merge request is merged.
14+
- [ ] Check any relevant CHANGELOG files have been updated.
15+
- [ ] Ensure documentation requirements are met e.g., public API is commented.
16+
- [ ] Consider any licensing/other legal implications for this MR e.g. notices required by any new libraries.
17+
- [ ] Add any relevant labels such as `breaking` to this MR.
18+
- [ ] Ensure package.json files are updated with new package versions and any changes dependency versions.
19+
- [ ] If this is a major release, action any `Obsolete` items and other breaking considerations.
20+
- [ ] Check that additional release tasks for each MR contributing to this release have been considered.
21+
22+
### Additional Release Tasks
23+
24+
_This task list should be populated from MRs contributing to this release. Can include functionality tests and regression tests such as tests for integration of multiple features as well as any other tasks that should be performed during the release._
25+
26+
- [ ]
27+
28+
## Closes JIRA Issue
29+
30+
_If this MR closes any JIRA issues list them below in the form `Closes PROJECT-#`_

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Contributing to Unity Plugin
2+
3+
We welcome contributions from the community. Feel free to create an issue or submit a pull request to address problems you've been having or add new functionality that others would be interested in.
4+
5+
## Review Threads
6+
Help the contributor when reviewing by using emoji's to show intent with each thread:
7+
* :eyes: - “Please do this, I want to look at it again once done / discuss it further” - reviewer is responsible for resolving thread
8+
* :see_no_evil: - “Please do this, I don’t need to look at it again once done” - MR submitter is responsible for resolving thread
9+
* :shrug: - “Suggestion, I don’t mind if you do it or not” - MR submitter is responsible for resolving thread
10+
* :+1: - “This is just a positive comment on your code, no changes needed” - MR submitter is responsible for resolving thread
11+
12+
Got ideas for any other emojis that would be helpful? Add them here with an MR :eyes:.

0 commit comments

Comments
 (0)