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

Jump to bottom

Create pull_request_template.md #36

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Create pull_request_template.md #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- Please refer to our contributing docs for any questions on submitting a pull request -->

Check notice on line 1 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L1 

Expected: 80; Actual: 93
<!-- Issues are required for both bug fixes and features. -->
Resolves #ISSUE_NUMBER

Check notice on line 3 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L3 

First line in a file should be a top-level heading
Comment on lines +1 to +3
Copy link

Choose a reason for hiding this comment

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

Add a top-level heading and improve clarity.

The first line should be a top-level heading for better structure. Additionally, clarify the comments to guide contributors better.

+ # Pull Request Template
<!-- Please refer to our contributing docs for any questions on submitting a pull request -->
<!-- Issues are required for both bug fixes and features. -->
Resolves #ISSUE_NUMBER
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<!-- Please refer to our contributing docs for any questions on submitting a pull request -->
<!-- Issues are required for both bug fixes and features. -->
Resolves #ISSUE_NUMBER
# Pull Request Template
<!-- Please refer to our contributing docs for any questions on submitting a pull request -->
<!-- Issues are required for both bug fixes and features. -->
Resolves #ISSUE_NUMBER
Tools
GitHub Check: Codacy Static Code Analysis

[notice] 1-1: .github/pull_request_template.md#L1
Expected: 80; Actual: 93

[notice] 3-3: .github/pull_request_template.md#L3
First line in a file should be a top-level heading


----

### Before the change?

Check notice on line 7 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L7 

Expected: [None]; Actual: ### Before the change?
<!-- Please describe the current behaviour that you are modifying. -->

*

Check notice on line 10 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L10 

Expected: 0 or 2; Actual: 1
Comment on lines +7 to +10
Copy link

Choose a reason for hiding this comment

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

Improve clarity and fix list formatting.

Clarify the placeholder to guide contributors better and fix the list formatting.

### Before the change
<!-- Please describe the current behavior that you are modifying. -->

*

Committable suggestion was skipped due to low confidence.

Tools
GitHub Check: Codacy Static Code Analysis

[notice] 7-7: .github/pull_request_template.md#L7
Expected: [None]; Actual: ### Before the change?

[notice] 10-10: .github/pull_request_template.md#L10
Expected: 0 or 2; Actual: 1


### After the change?
<!-- Please describe the behaviour or changes that are being added by this PR. -->

*
Comment on lines +12 to +15
Copy link

Choose a reason for hiding this comment

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

Improve clarity and fix list formatting.

Clarify the placeholder to guide contributors better and fix the list formatting.

### After the change
<!-- Please describe the behavior or changes that are being added by this PR. -->

*
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### After the change?
<!-- Please describe the behaviour or changes that are being added by this PR. -->
*
### After the change
<!-- Please describe the behavior or changes that are being added by this PR. -->
*


### Pull request checklist

Check notice on line 17 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L17 

Expected: 1; Actual: 0; Below
- [ ] Tests for the changes have been added (for bug fixes/features)

Check notice on line 18 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L18 

Expected: asterisk; Actual: dash

Check notice on line 18 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L18 

Lists should be surrounded by blank lines
- [ ] Docs have been reviewed and added/updated if needed (for bug fixes/features)

Check notice on line 19 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L19 

Expected: asterisk; Actual: dash
Comment on lines +17 to +19
Copy link

Choose a reason for hiding this comment

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

Fix list formatting.

Ensure the list items are correctly formatted and surrounded by blank lines.

### Pull request checklist

* [ ] Tests for the changes have been added (for bug fixes/features)
* [ ] Docs have been reviewed and added/updated if needed (for bug fixes/features)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Pull request checklist
- [ ] Tests for the changes have been added (for bug fixes/features)
- [ ] Docs have been reviewed and added/updated if needed (for bug fixes/features)
### Pull request checklist
* [ ] Tests for the changes have been added (for bug fixes/features)
* [ ] Docs have been reviewed and added/updated if needed (for bug fixes/features)
Tools
GitHub Check: Codacy Static Code Analysis

[notice] 17-17: .github/pull_request_template.md#L17
Expected: 1; Actual: 0; Below

[notice] 18-18: .github/pull_request_template.md#L18
Expected: asterisk; Actual: dash

[notice] 18-18: .github/pull_request_template.md#L18
Lists should be surrounded by blank lines

[notice] 19-19: .github/pull_request_template.md#L19
Expected: asterisk; Actual: dash


### Does this introduce a breaking change?
<!-- If this introduces a breaking change, make sure to note it here and what the impact might be -->

Check notice on line 22 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L22 

Expected: 80; Actual: 101

- [ ] Yes

Check notice on line 24 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L24 

Expected: asterisk; Actual: dash
- [ ] No

Check notice on line 25 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L25 

Expected: asterisk; Actual: dash
Comment on lines +21 to +25
Copy link

Choose a reason for hiding this comment

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

Improve clarity, make the section more explicit, and fix list formatting.

Clarify the placeholder, make the section more explicit, and ensure the list items are correctly formatted.

### Does this introduce a breaking change?
<!-- If this introduces a breaking change, make sure to note it here and what the impact might be -->

* [ ] Yes
* [ ] No
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Does this introduce a breaking change?
<!-- If this introduces a breaking change, make sure to note it here and what the impact might be -->
- [ ] Yes
- [ ] No
### Does this introduce a breaking change?
<!-- If this introduces a breaking change, make sure to note it here and what the impact might be -->
* [ ] Yes
* [ ] No
Tools
GitHub Check: Codacy Static Code Analysis

[notice] 22-22: .github/pull_request_template.md#L22
Expected: 80; Actual: 101

[notice] 24-24: .github/pull_request_template.md#L24
Expected: asterisk; Actual: dash

[notice] 25-25: .github/pull_request_template.md#L25
Expected: asterisk; Actual: dash


----
Comment on lines +1 to +27
Copy link

Choose a reason for hiding this comment

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

CODE REVIEW

  1. Add more clarity to the comment placeholders to guide contributors better.
  2. Ensure issue number is referenced correctly with a hash.
  3. Make the breaking change section more explicit.
<!-- Refer to contributing docs for questions about submitting a PR -->
<!-- Issues are required for both bug fixes and features. -->
Resolves #ISSUE_NUMBER

----

### Before the change
<!-- Describe the current behavior being modified. -->

*

### After the change
<!-- Describe the new behavior implemented by this PR. -->

*

### Pull request checklist
- [ ] Tests added for changes (bug fixes/features)
- [ ] Documentation reviewed and updated if needed

### Breaking change
<!-- Does this introduce a breaking change? Note the impact. -->
- [ ] Yes
- [ ] No

----

Loading