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.

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

Update PULL_REQUEST_TEMPLATE.md to link the contribute page #2592

Merged
merged 3 commits into from
Aug 29, 2024

Conversation

Real-MullaC
Copy link
Contributor

@Real-MullaC Real-MullaC commented Aug 20, 2024

Pull Request

Title

Update PULL_REQUEST_TEMPLATE.md to link the contribute page

Type of Change

  • New feature
  • Bug fix
  • Documentation update
  • Refactoring
  • Hotfix
  • Security patch
  • UI/UX improvement

Description

Update PULL_REQUEST_TEMPLATE.md to link the contribute page

Testing

None required

Impact

High as it makes sure all PR's are done correctly.

Issue related to PR

[What issue/discussion is related to this PR (if any)]

  • Resolves no issues

Additional Information

Nope

Checklist

  • My code adheres to the coding and style guidelines of the project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no errors/warnings/merge conflicts.

Copy link
Contributor

@CodingWonders CodingWonders left a comment

Choose a reason for hiding this comment

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

A necessary change to make contributing easier for newcomers. I like it!

@MyDrift-user
Copy link
Contributor

MyDrift-user commented Aug 20, 2024

@Real-MullaC
While reading this change and the current template I saw that there are many infos for the PR creator that are not important to the reviewer (most stuff in [ ] ).
For that we could use markdown comments, they work as intendet in github conversations ... and are visible in the editor, but not in the finished PR Description that u see when not editing the description. What do you think about it?
how to do it: {
<!-- This is a comment in Markdown -->
}
how it looks while not editing: {

}

@Real-MullaC
Copy link
Contributor Author

@Real-MullaC While reading this change and the current template I saw that there are many infos for the PR creator that are not important to the reviewer (most stuff in [ ] ). For that we could use markdown comments, they work as intendet in github conversations ... and are visible in the editor, but not in the finished PR Description that u see when not editing the description. What do you think about it? how to do it: { <!-- This is a comment in Markdown --> } how it looks while not editing: {

}

Changed

@MyDrift-user
Copy link
Contributor

MyDrift-user commented Aug 20, 2024

could you please also do this with everything that is in "[ ]"

@Real-MullaC
Copy link
Contributor Author

could you please also do this with everything that is in "[ ]"

Done

Copy link
Contributor

@MyDrift-user MyDrift-user left a comment

Choose a reason for hiding this comment

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

Thanks, looks great now

Copy link
Contributor

@CodingWonders CodingWonders left a comment

Choose a reason for hiding this comment

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

That is better for a pull request template

@ChrisTitusTech ChrisTitusTech force-pushed the main branch 2 times, most recently from 7805fe4 to cfb9edb Compare August 26, 2024 22:01
@ChrisTitusTech ChrisTitusTech merged commit 2b7d0b6 into ChrisTitusTech:main Aug 29, 2024
1 check passed
@ChrisTitusTech ChrisTitusTech added the skip-changelog Skip Change Logs label Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Skip Change Logs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants