Skip to content
Merged
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
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
- Thanks for your contribution! Please replace this text with a description of what this PR is changing or adding and why, list any relevant issues, and review the contribution guidelines below.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The introductory text is formatted as a list item due to the leading -. It would be more appropriate as a regular paragraph for better readability.

Suggested change
- Thanks for your contribution! Please replace this text with a description of what this PR is changing or adding and why, list any relevant issues, and review the contribution guidelines below.
Thanks for your contribution! Please replace this text with a description of what this PR is changing or adding and why, list any relevant issues, and review the contribution guidelines below.


---

- [ ] I’ve reviewed the contributor guide and applied the relevant portions to this PR.

<details>
<summary>Contribution guidelines:</summary><br>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The <br> tag after the <summary> is unnecessary and not standard practice. A blank line after the <summary> tag is sufficient to start the content of the <details> block on a new line, and is cleaner.

Suggested change
<summary>Contribution guidelines:</summary><br>
<summary>Contribution guidelines:</summary>


- See our [contributor guide]([https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md](https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md) for general expectations for PRs.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The markdown syntax for the link to the contributor guide is incorrect due to nested link syntax [text]([url](url)). This will result in a broken link in the rendered pull request description. It should be corrected to the standard [text](url) format.

Suggested change
- See our [contributor guide]([https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md](https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md) for general expectations for PRs.
- See our [contributor guide](https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md) for general expectations for PRs.

- Larger or significant changes should be discussed in an issue before creating a PR.
- Dart contributions to our repos should follow the [Dart style guide](https://dart.dev/guides/language/effective-dart) and use `dart format`.
- Java and Kotlin contributions should strive to follow Java and Kotlin best practices ([discussion](https://github.com/flutter/flutter-intellij/issues/8098)).
</details>
Loading