chore(template): improve PullRequest template #5622
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,72 @@ | ||
| ## Prerequisites | ||
|
|
||
| - [ ] I have read and understood the [Contributing Guide][contributing]. | ||
| - [ ] My commit messages are written according the [Conventional Commits][cc] guidelines, respecting our [rules][commitlint]. | ||
| - [ ] Relevant tests have been added or updated (for bug fixes or features). | ||
| - [ ] Documentations have been added or updated (for bug fixes or features). | ||
|
|
||
| ## Description | ||
|
|
||
| <!-- | ||
|
|
||
| **Description of Changes:** | ||
|
|
||
| Please provide a clear and concise description of the changes introduced by this pull request. Explain the following when relevant: | ||
|
|
||
| 1. **Summary:** Briefly describe the main change or addition in this PR. What is the overall purpose of your changes? | ||
| 2. **Problem:** Specify the issue or problem this PR addresses. Include any relevant context or background to explain why this change is necessary. | ||
| 3. **Solution:** Explain how your changes resolve the issue or add the new feature. Provide key implementation details to clarify how the solution works. | ||
| 4. **Impact:** Note any potential impacts or side effects of your changes. Mention if additional testing is needed or if there are any known limitations. | ||
| 5. **Issue Closure:** Indicate which issues this PR resolves or closes. | ||
|
|
||
| **Example:** | ||
| "This PR introduces a new feature for X by implementing Y that will optimize the query logic, which reduces execution time and prevents the error. This change addresses the issue reported in #123. | ||
|
|
||
| Closes #123" | ||
|
|
||
| Please ensure that each section is thoroughly explained to assist reviewers in understanding your changes. | ||
|
|
||
| --> | ||
|
|
||
| --- | ||
|
|
||
| <br> | ||
| <br> | ||
| <br> | ||
|
|
||
|
|
||
| <!-- _Description of your changes:_ --> | ||
|
|
||
|
|
||
|
|
||
| <br> | ||
| <br> | ||
| <br> | ||
| <br> | ||
|
|
||
| --- | ||
|
|
||
| ### Helpful Resources | ||
|
|
||
|
There was a problem hiding this comment. there's a reason this was hidden, we shouldn't see this after creation There was a problem hiding this comment. Are you sure you want to comment that? It has a styling aspect for the preview, but it will also take up some space. |
||
| - **[Getting Started Guide][started-guide]:** For first-time contributors, this guide will help you get acquainted with the project. | ||
| - **[Oh My Posh Git Guide][git-guide]:** For understanding Git practices and commands. | ||
| - **[Discussions Page][discussions]:** Join project discussions and ask questions. | ||
| - **[GitKraken Guide][gitkraken]:** Recommended tool for managing Git repositories. | ||
| <!-- - **[Code Structure Guide][code-structure]:** Understand the overall organization of our codebase. --> | ||
|
|
||
|
There was a problem hiding this comment. I think it's somewhat related to the pull request. It helps contributors better understand the PR. |
||
| - **[Community Standard][community]:** Engage with the community and understand our community standards. | ||
| - **[Contributing Guide][contributing]:** Read and understand our guidelines for contributing. | ||
| - **[GitHub’s Pull Request Review Guide][gh-pr-review]:** Additional guidance on the review process. | ||
| <!-- - **[Pitfalls to Avoid][pitfalls]:** Common mistakes to watch out for when contributing. --> | ||
|
|
||
|
There was a problem hiding this comment. I think it's somewhat related to the pull request. It helps contributors better understand the PR. |
||
|
|
||
|
|
||
| [contributing]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/CONTRIBUTING.md | ||
| [cc]: https://www.conventionalcommits.org/en/v1.0.0/#summary | ||
| [commitlint]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/.commitlintrc.yml | ||
| [started-guide]: https://ohmyposh.dev/docs/contributing/started | ||
| [git-guide]: https://ohmyposh.dev/docs/contributing/git | ||
| [discussions]: https://github.com/JanDeDobbeleer/oh-my-posh/discussions | ||
| [gitkraken]: https://www.gitkraken.com/invite/nQmDPR9D | ||
| [community]: https://github.com/JanDeDobbeleer/oh-my-posh/community | ||
| [gh-pr-review]: https://help.github.com/en/articles/about-pull-request-reviews | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why are the linebreaks here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The line breaks are used to emphasize the main PR description section, making it easier to focus on providing a clear and concise overview of the changes.