chore(template): improve PullRequest template #5622
Conversation
- Added sections for clear description including summary, problem, solution, and impact. - Updated Helpful Resources section with links to contributing guides, Git practices, and community standards.
Co-authored-by: L. Yeung <[email protected]>
1. **Commitlint Rules:** Added a reference to commitlint rules and standards to ensure that commit messages follow guidelines. 2. **Extended Description:** Expanded the description section to include an additional point for indicating which issues the PR resolves or closes. These updates aim to enhance clarity and ensure that pull requests adhere to our contribution and commit message standards.
| [CONTRIBUTING.md]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/CONTRIBUTING.md | ||
| --- | ||
|
|
||
| <br> |
There was a problem hiding this comment.
why are the linebreaks here?
There was a problem hiding this comment.
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.
| - **[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.
I think adding this section to the docs is a good idea; we can link to the page we’ll create in the template. We can use this interim solution until the docs section is finalized.
|
|
||
| --- | ||
|
|
||
| ### 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.
| - **[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.
I think adding this section to the docs is a good idea; we can link to the page we’ll create in the template. We can use this interim solution until the docs section is finalized.
Co-authored-by: Jan De Dobbeleer <[email protected]>
Co-authored-by: Jan De Dobbeleer <[email protected]>
|
Did I make a mistake that I should fix? |
@ClxUne09 I was in doubt if I should merge this. I wasn't immediately convinced by the guidelines as I'm not really missing anything usually. When I get that feeling I let things marinate a bit, but TBH, I still feel the same. |
You’re right; these changes focus more on the details rather than the actual parts. I will close this pull request for now. Thank you for your reply. |
Prerequisites
Description
05e491b:
These updates aim to enhance clarity and ensure that pull requests adhere to our contribution and commit message standards.