e1e82cef08
* Add warning to pull request template * Add a new section to the `CONTRIBUTING.md` file too with similar contents
62 lines
2.5 KiB
Markdown
62 lines
2.5 KiB
Markdown
<!--
|
|
|
|
Please read [CONTRIBUTING.md](https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md) before submitting your pull request.
|
|
|
|
Are you adding a new feature? Keep in mind that it needs to be added to [the iOS client](https://github.com/element-hq/element-x-ios) too, unless it's related to an Android OS only behaviour.
|
|
|
|
**IMPORTANT:** if you are adding new screens or modifying existing ones, this needs acceptance from the product and design teams before being merged. For this, it's better to start with a [feature request issue](https://github.com/element-hq/element-x-android/issues/new?template=enhancement.yml) describing the change you want to make and the motivation behind it instead of directly creating a pull request. This will allow the product and design teams to give feedback on the change before you start working on it, and avoid you doing work that might end up being rejected.
|
|
|
|
-->
|
|
|
|
## Content
|
|
|
|
<!-- Describe shortly what has been changed -->
|
|
|
|
## Motivation and context
|
|
|
|
<!-- Provide link to the corresponding issue if applicable or explain the context -->
|
|
|
|
## Screenshots / GIFs
|
|
|
|
<!--
|
|
We have screenshot tests in the project, so attaching screenshots to a PR is not mandatory, as far as there
|
|
is a Composable Preview covering the changes. In this case, the change will appear in the file diff.
|
|
Note that all the UI composables should be covered by a Composable Preview.
|
|
|
|
Providing a video of the change is still very useful for the reviewer and for the history of the project.
|
|
|
|
You can use a table like this to show screenshots comparison.
|
|
Uncomment this markdown table below and edit the last line `|||`:
|
|
|copy screenshot of before here|copy screenshot of after here|
|
|
|
|
|Before|After|
|
|
|-|-|
|
|
|||
|
|
-->
|
|
|
|
## Tests
|
|
|
|
<!-- Explain how you tested your development -->
|
|
|
|
- Step 1
|
|
- Step 2
|
|
- Step ...
|
|
|
|
## Tested devices
|
|
|
|
- [ ] Physical
|
|
- [ ] Emulator
|
|
- OS version(s):
|
|
|
|
## Checklist
|
|
|
|
<!-- Depending on the Pull Request content, it can be acceptable if some of the following checkboxes stay unchecked. -->
|
|
|
|
- [ ] Changes have been tested on an Android device or Android emulator with API 24
|
|
- [ ] UI change has been tested on both light and dark themes
|
|
- [ ] Accessibility has been taken into account. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#accessibility
|
|
- [ ] Pull request is based on the develop branch
|
|
- [ ] Pull request title will be used in the release note, it clearly define what will change for the user
|
|
- [ ] Pull request includes screenshots or videos if containing UI changes
|
|
- [ ] You've made a self review of your PR
|