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

Fix formats in the comments #1303

Merged
merged 2 commits into from
Jan 26, 2025
Merged

Conversation

IzN432
Copy link
Contributor

@IzN432 IzN432 commented Jan 22, 2025

Summary:

Addresses part of #1299

Changes Made:

  • Remove the extra full stop after Team Chose [ {{ tag }} ] and Originally [ {{ tag }} ] from commented templates
  • Replace the newline after **Reason for disagreement:** with a space from commented templates

Proposed Commit Message:

Fix incorrect format of commented templates

Templates for the tester response phase's comments on GitHub found in 
the code comments are incorrect. The templates include an extra full 
stop after "Team Chose [ {{ tag }} ]" and "Originally [ {{ tag }} ]" and 
a new line after "**Reason for disagreement:**". 

This causes the issue to be filed under faulty issues when viewed in the 
Tester response phase on CATcher.

Let's fix the formats by removing the extra full stops and replacing the 
new line with a space.

Copy link
Contributor

@Arif-Khalid Arif-Khalid left a comment

Choose a reason for hiding this comment

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

Great PR that fixes the comment inaccuracy of the template. Just some github related comments.
In this case the linked issue contains multiple parts that cannot be fixed in this one PR. Therefore, in order for github to not automatically close the linked issue on merge, could you change the Fixes [issue_number] to something like Addresses part of [issue_number] in the PR description.
Additionally, it would be good to update the proposed commit message to something more descriptive for standardization regardless of PR size. You may refer to the git convention linked to by our CATcher documentation. I will put a direct link here.

@IzN432
Copy link
Contributor Author

IzN432 commented Jan 26, 2025

@Arif-Khalid made the requested changes!

Copy link
Contributor

@Arif-Khalid Arif-Khalid left a comment

Choose a reason for hiding this comment

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

LGTM! Great PR fixing an important developer issue! 😄

@Arif-Khalid Arif-Khalid merged commit 8fc0feb into CATcher-org:master Jan 26, 2025
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants