-
-
Notifications
You must be signed in to change notification settings - Fork 777
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
[Do not review PR] Update PR template with CodeQL instructions #7546
[Do not review PR] Update PR template with CodeQL instructions #7546
Conversation
Want to review this pull request? Take a look at this documentation for a step by step guide! From your project repository, check out a new branch and test the changes.
|
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.
Hey @santisecco good job on taking on this issue.
Things that went well:
- The branch name is correct
- The issue is linked
- The changes are correct on the correct template.md
Things that need to be changed:
- Could we move the issue from the "Prioritized Backlog" to the "In Progress" tab, as it's now being addressed?
- It would be helpful to update the title to something more descriptive, such as "Updated".
- Additionally, please add a "Screenshots" section, noting that there are no visual changes for this update.
- The sections
What changes did you make?
Why did you make the changes (we will use this info to test)?
can be a little more descriptive.
Hi @codyyjxn thanks for the feedback. The What and Why sections I believe are ok, because the idea was just to add that section to the PR template. But I somehow changed them. I added the "Screenshot" section, with the PR template and its changes, even though the website code was not modified. But before reviewing let me ask something to the team leads, because honestly I believe this new PR template will be confusing to new developers and it will affect every single PR that is made. |
Fixes #replace_this_text_with_the_issue_number What changes did you make?Why did you make the changes (we will use this info to test)?CodeQL AlertsAfter the PR has been submitted and the resulting GitHub actions/checks have been completed, developers should check the PR for CodeQL alert annotations. If your issue has a CodeQL alert and is complexity: medium or higher, please let us know that you have checked and resolved. Please do not dismiss alerts.
InstructionsIf CodeQL alert/annotations appear, refer to How to Resolve CodeQL alerts. In general, CodeQL alerts should be resolved prior to PR reviews and merging Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes) |
Fixes #5196
What changes did you make?
pull_request_template.md
adding CodeQL instructions section. Please refer to the links below.Why did you make the changes (we will use this info to test)?
Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)
No visual changes to the website itself.
Even though, the following links are there to preview the changes to the Pull Request template.
Previous PR template: https://github.com/hackforla/website/blob/gh-pages/.github/pull_request_template.md
Updated PR template: https://github.com/santisecco/website/blob/update-pr-template-codeql-5196/.github/pull_request_template.md