Update project config #25
Conversation
Code Metrics Report
Details | | main (b1804ea) | #25 (16e7bdd) | +/- |
|---------------------|----------------|---------------|------|
| Coverage | 93.0% | 93.0% | 0.0% |
| Files | 24 | 24 | 0 |
| Lines | 511 | 511 | 0 |
| Covered | 475 | 475 | 0 |
+ | Test Execution Time | 7s | 1s | -6s |Reported by octocov |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
WalkthroughThe project has been updated to include a new Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 17
Out of diff range and nitpick comments (7)
README.md (7)
Line range hint
22-22: Remove trailing spaces.- +Also applies to: 25-25, 27-27, 33-33, 37-37
Line range hint
50-50: Replace hard tabs with spaces.- <code with hard tabs> + <code with spaces>Also applies to: 52-52, 56-94, 157-159, 165-174, 193-200, 242-247, 269-272, 278-299, 358-361, 367-375, 377-479, 488-503, 511-526, 535-536, 538-539, 545-549, 551-573, 585-592, 599-606, 615-619, 625-629, 631-639, 641-648, 699-705
Line range hint
9-9: Headings should be surrounded by blank lines.-# Heading +# Heading +Also applies to: 16-16, 20-20, 40-40, 44-45, 149-149, 189-189, 238-238, 675-675, 734-734, 737-737
Line range hint
225-225: Remove blank lines inside blockquote.-> If you can dream it, you can do it. +> If you can dream it, you can do it.Also applies to: 228-228, 231-231, 234-234
Line range hint
46-46: Fenced code blocks should be surrounded by blank lines.-```go +```go +Also applies to: 99-99, 153-153, 179-179, 184-184, 192-192, 204-204, 241-241, 251-251, 306-306, 331-331, 484-484, 509-509, 578-578, 597-597, 653-653, 666-666, 711-711
Line range hint
17-17: Lists should be surrounded by blank lines.-- List item +- List item +Also applies to: 21-21, 41-41, 147-147
Line range hint
99-99: Fenced code blocks should have a language specified.-``` +```goAlso applies to: 306-306, 484-484, 578-578, 653-653
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- CHANGELOG.md (1 hunks)
- CONTRIBUTING.md (1 hunks)
- README.md (1 hunks)
Additional comments not posted (1)
README.md (1)
738-738: Reference toCONTRIBUTING.mdlooks good.
| @@ -0,0 +1,11 @@ | |||
| ## Contributing as a Developer | |||
There was a problem hiding this comment.
Add a blank line after the heading for better readability.
## Contributing as a Developer
+
- When creating a bug report: Please follow the template and provide detailed information.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.
| ## Contributing as a Developer | |
| ## Contributing as a Developer | |
| - When fixing a feature: Create a Pull Request (PR) with accompanying test code. | ||
| - When adding a feature: First, propose the feature in an Issue. | ||
|
|
||
| ## Contributing Outside of Coding |
There was a problem hiding this comment.
Add a blank line after the heading for better readability.
## Contributing Outside of Coding
+
The following actions help boost my motivation: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.
| ## Contributing Outside of Coding | |
| ## Contributing Outside of Coding | |
| The following actions help boost my motivation: |
| @@ -0,0 +1,11 @@ | |||
| ## Contributing as a Developer | |||
| - When creating a bug report: Please follow the template and provide detailed information. | |||
There was a problem hiding this comment.
Add a blank line before the list for better readability.
## Contributing as a Developer
- When creating a bug report: Please follow the template and provide detailed information.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.
| - When creating a bug report: Please follow the template and provide detailed information. | |
| ## Contributing as a Developer | |
| - When creating a bug report: Please follow the template and provide detailed information. |
| - When adding a feature: First, propose the feature in an Issue. | ||
|
|
||
| ## Contributing Outside of Coding | ||
| The following actions help boost my motivation: |
There was a problem hiding this comment.
Add a blank line before the list for better readability.
The following actions help boost my motivation:
- Giving a GitHub StarCommittable 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.
| The following actions help boost my motivation: | |
| The following actions help boost my motivation: | |
| @@ -1,3 +1,47 @@ | |||
| ## [](https://github.com/nao1215/markdown/compare/v0.2.0...) (2024-05-05) | |||
| ## [](https://github.com/nao1215/markdown/compare/v0.4.0...) (2024-05-15) | |||
There was a problem hiding this comment.
Remove the extra blank lines for better readability.
## [](https://github.com/nao1215/markdown/compare/v0.4.0...) (2024-05-15)
-
## [v0.4.0](https://github.com/nao1215/markdown/compare/v0.3.0...v0.4.0) (2024-05-06)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.
| ## [](https://github.com/nao1215/markdown/compare/v0.4.0...) (2024-05-15) | |
| ## [](https://github.com/nao1215/markdown/compare/v0.4.0...) (2024-05-15) | |
| ## [v0.4.0](https://github.com/nao1215/markdown/compare/v0.3.0...v0.4.0) (2024-05-06) |
| ## [v0.0.6](https://github.com/nao1215/markdown/compare/v0.0.5...v0.0.6) (2023-11-04) | ||
|
|
||
|
|
||
| ## [v0.0.5](https://github.com/nao1215/markdown/compare/v0.0.4...v0.0.5) (2023-11-04) |
There was a problem hiding this comment.
Remove the extra blank lines for better readability.
## [v0.0.5](https://github.com/nao1215/markdown/compare/v0.0.4...v0.0.5) (2023-11-04)
-
## [v0.0.4](https://github.com/nao1215/markdown/compare/v0.0.3...v0.0.4) (2023-11-04)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.
| ## [v0.0.5](https://github.com/nao1215/markdown/compare/v0.0.4...v0.0.5) (2023-11-04) | |
| ## [v0.0.5](https://github.com/nao1215/markdown/compare/v0.0.4...v0.0.5) (2023-11-04) | |
| ## [v0.0.4](https://github.com/nao1215/markdown/compare/v0.0.3...v0.0.4) (2023-11-04) |
| ## [v0.0.5](https://github.com/nao1215/markdown/compare/v0.0.4...v0.0.5) (2023-11-04) | ||
|
|
||
|
|
||
| ## [v0.0.4](https://github.com/nao1215/markdown/compare/v0.0.3...v0.0.4) (2023-11-04) |
There was a problem hiding this comment.
Remove the extra blank lines for better readability.
## [v0.0.4](https://github.com/nao1215/markdown/compare/v0.0.3...v0.0.4) (2023-11-04)
-
## [v0.0.3](https://github.com/nao1215/markdown/compare/v0.0.2...v0.0.3) (2023-11-04)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.
| ## [v0.0.4](https://github.com/nao1215/markdown/compare/v0.0.3...v0.0.4) (2023-11-04) | |
| ## [v0.0.4](https://github.com/nao1215/markdown/compare/v0.0.3...v0.0.4) (2023-11-04) | |
| ## [v0.0.3](https://github.com/nao1215/markdown/compare/v0.0.2...v0.0.3) (2023-11-04) |
| ## [v0.0.4](https://github.com/nao1215/markdown/compare/v0.0.3...v0.0.4) (2023-11-04) | ||
|
|
||
|
|
||
| ## [v0.0.3](https://github.com/nao1215/markdown/compare/v0.0.2...v0.0.3) (2023-11-04) |
There was a problem hiding this comment.
Remove the extra blank lines for better readability.
## [v0.0.3](https://github.com/nao1215/markdown/compare/v0.0.2...v0.0.3) (2023-11-04)
-
## [v0.0.2](https://github.com/nao1215/markdown/compare/v0.0.1...v0.0.2) (2023-10-26)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.
| ## [v0.0.3](https://github.com/nao1215/markdown/compare/v0.0.2...v0.0.3) (2023-11-04) | |
| ## [v0.0.3](https://github.com/nao1215/markdown/compare/v0.0.2...v0.0.3) (2023-11-04) | |
| ## [v0.0.2](https://github.com/nao1215/markdown/compare/v0.0.1...v0.0.2) (2023-10-26) |
| ## [v0.0.3](https://github.com/nao1215/markdown/compare/v0.0.2...v0.0.3) (2023-11-04) | ||
|
|
||
|
|
||
| ## [v0.0.2](https://github.com/nao1215/markdown/compare/v0.0.1...v0.0.2) (2023-10-26) |
There was a problem hiding this comment.
Remove the extra blank lines for better readability.
## [v0.0.2](https://github.com/nao1215/markdown/compare/v0.0.1...v0.0.2) (2023-10-26)
-
## [v0.0.1](https://github.com/nao1215/markdown/compare/f79596a1a1e4...v0.0.1) (2023-10-22)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.
| ## [v0.0.2](https://github.com/nao1215/markdown/compare/v0.0.1...v0.0.2) (2023-10-26) | |
| ## [v0.0.2](https://github.com/nao1215/markdown/compare/v0.0.1...v0.0.2) (2023-10-26) | |
| ## [v0.0.1](https://github.com/nao1215/markdown/compare/f79596a1a1e4...v0.0.1) (2023-10-22) |
| ## [v0.0.2](https://github.com/nao1215/markdown/compare/v0.0.1...v0.0.2) (2023-10-26) | ||
|
|
||
|
|
||
| ## [v0.0.1](https://github.com/nao1215/markdown/compare/f79596a1a1e4...v0.0.1) (2023-10-22) |
There was a problem hiding this comment.
Remove the extra blank lines for better readability.
## [v0.0.1](https://github.com/nao1215/markdown/compare/f79596a1a1e4...v0.0.1) (2023-10-22)
- 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.
| ## [v0.0.1](https://github.com/nao1215/markdown/compare/f79596a1a1e4...v0.0.1) (2023-10-22) | |
| ## [v0.0.1](https://github.com/nao1215/markdown/compare/f79596a1a1e4...v0.0.1) (2023-10-22) |
Summary by CodeRabbit
CONTRIBUTING.mdfile with guidelines for contributing to the project.README.mdto reference the newCONTRIBUTING.mdfor more detailed information.