Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(template): improve PullRequest template #5622

Closed
wants to merge 8 commits into from
Closed

chore(template): improve PullRequest template #5622

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
544179e
chore(template): improve PullRequest template
ClxUne09 Sep 15, 2024
a2845ef
style(template): refine PullRequest template for clarity
ClxUne09 Sep 15, 2024
2d42bbc
Merge branch 'main' into pr-templ
ClxUne09 Sep 17, 2024
05e491b
chore(template): update PullRequest template
ClxUne09 Sep 19, 2024
8440de0
Merge branch 'main' into pr-templ
ClxUne09 Sep 19, 2024
a58ea66
refactor(template): update PR commit message guidelines
ClxUne09 Sep 22, 2024
7868db5
refactor(template): clarify requested description for PR
ClxUne09 Sep 22, 2024
71d58ac
Merge branch 'main' into pr-templ
ClxUne09 Sep 30, 2024
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
75 changes: 63 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,72 @@
### Prerequisites
## Prerequisites

- [ ] I have read and understood the [contributing guide][CONTRIBUTING.md].
- [ ] The commit message follows the [conventional commits][cc] guidelines.
- [ ] Tests for the changes have been added (for bug fixes / features).
- [ ] Docs have been added/updated (for bug fixes / features).
- [ ] I have read and understood the [Contributing Guide][contributing].
- [ ] My commit messages follow the [Conventional Commits][cc] guidelines and our [commitlint rules and standards][commitlint].
- [ ] Relevant tests have been added or updated (for bug fixes or features).
ClxUne09 marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Documentations have been added or updated (for bug fixes or features).

### Description
## Description

<!---
<!--

Tips:
**Description of Changes:**

If you're not comfortable with working with Git,
we're working a guide (https://ohmyposh.dev/docs/contributing/git) to help you out.
Oh My Posh advises GitKraken (https://www.gitkraken.com/invite/nQmDPR9D) as your preferred cross platform Git GUI power tool.
Please provide a clear and concise description of the changes introduced by this pull request. You should explain the following:

ClxUne09 marked this conversation as resolved.
Show resolved Hide resolved
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.

-->

[CONTRIBUTING.md]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/CONTRIBUTING.md
---

<br>
<br>
Copy link
Owner

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?

Copy link
Contributor Author

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.

<br>


<!-- _Description of your changes:_ -->



<br>
<br>
<br>
<br>

---

### Helpful Resources

Copy link
Owner

Choose a reason for hiding this comment

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

there's a reason this was hidden, we shouldn't see this after creation

Copy link
Contributor Author

@ClxUne09 ClxUne09 Sep 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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. -->

Copy link
Owner

Choose a reason for hiding this comment

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

this isn't relevant here

Copy link
Contributor Author

@ClxUne09 ClxUne09 Sep 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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.

- **[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. -->

Copy link
Owner

Choose a reason for hiding this comment

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

this isn't relevant here

Copy link
Contributor Author

@ClxUne09 ClxUne09 Sep 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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.



[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
Loading