-
-
Notifications
You must be signed in to change notification settings - Fork 17
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 project config #149
Conversation
WalkthroughThe recent updates involve a mix of configuration changes, documentation updates, and workflow adjustments. Key highlights include updating funding options, refining issue templates, upgrading Go versions for testing, broadening 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 (
|
HOTTEST report
Reported by hottest |
Code Metrics Report
Details | | main (e37150f) | #149 (eab1224) | +/- |
|---------------------|----------------|----------------|------|
| Coverage | 77.5% | 77.5% | 0.0% |
| Files | 20 | 20 | 0 |
| Lines | 772 | 772 | 0 |
| Covered | 598 | 598 | 0 |
+ | Test Execution Time | 17s | 4s | -13s | Reported by octocov |
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.
Actionable comments posted: 28
Out of diff range and nitpick comments (5)
.github/ISSUE_TEMPLATE/bug_report.md (5)
Line range hint
10-10
: Headings should be surrounded by blank lines for better readability.## gup version** -v0.y.z + +v0.y.z
Line range hint
13-13
: Headings should be surrounded by blank lines for better readability.## Steps to reproduce -Steps to reproduce the bug. + +Steps to reproduce the bug.
Line range hint
16-16
: Headings should be surrounded by blank lines for better readability.## Expected behavior -Expected behavior. + +Expected behavior.
Line range hint
19-19
: Headings should be surrounded by blank lines for better readability.## Additional details** -Any other useful data to share. + +Any other useful data to share.
Line range hint
19-19
: The phrase "Expected behavior" is duplicated. It should be used only once.## Steps to reproduce Steps to reproduce the bug. ## Expected behavior -Expected behavior.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
go.mod
is excluded by!**/*.mod
Files selected for processing (9)
- .github/FUNDING.yml (1 hunks)
- .github/ISSUE_TEMPLATE/bug_report.md (2 hunks)
- .github/workflows/multi_ver_unittest.yml (1 hunks)
- .gitignore (1 hunks)
- CHANGELOG.md (1 hunks)
- CODE_OF_CONDUCT.md (1 hunks)
- CONTRIBUTING.md (1 hunks)
- Makefile (1 hunks)
- SECURITY.md (1 hunks)
Files skipped from review due to trivial changes (4)
- .github/FUNDING.yml
- .github/workflows/multi_ver_unittest.yml
- .gitignore
- SECURITY.md
Additional comments not posted (3)
CODE_OF_CONDUCT.md (1)
1-1
: The simplification of the code of conduct to a single directive is clear and concise..github/ISSUE_TEMPLATE/bug_report.md (1)
4-4
: The placeholder text in the title has been simplified, which is a good change for clarity.Makefile (1)
1-1
: The addition of new targets to thePHONY
list is correct and improves the Makefile.
@@ -1,141 +1,11 @@ | |||
<!-- omit in toc --> | |||
## Contributing as a Developer |
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.
Headings should be surrounded by blank lines 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 creating a bug report: Please follow the template and provide detailed information. |
|
||
# Contributing to gup | ||
## Contributing Outside of Coding |
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.
Headings should be surrounded by blank lines 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: |
@@ -2,140 +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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lists should be surrounded by blank lines for better readability.
- When creating a bug report: Please follow the template and provide detailed information.
+
- 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. | |
- When creating a bug report: Please follow the template and provide detailed information. | |
@@ -0,0 +1,271 @@ | |||
## [](https://github.com/nao1215/gup/compare/v0.26.0...) (2024-05-15) |
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.
Fix the missing version number in the link.
- ## [](https://github.com/nao1215/gup/compare/v0.26.0...) (2024-05-15)
+ ## [v0.26.1](https://github.com/nao1215/gup/compare/v0.26.0...v0.26.1) (2024-05-15)
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/gup/compare/v0.26.0...) (2024-05-15) | |
## [v0.26.1](https://github.com/nao1215/gup/compare/v0.26.0...v0.26.1) (2024-05-15) |
@@ -0,0 +1,271 @@ | |||
## [](https://github.com/nao1215/gup/compare/v0.26.0...) (2024-05-15) | |||
|
|||
* Bump github.com/fatih/color from 1.16.0 to 1.17.0 [#148](https://github.com/nao1215/gup/pull/148) ([dependabot[bot]](https://github.com/apps/dependabot)) |
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.
Fix the missing closing bracket for the link.
- * Bump github.com/fatih/color from 1.16.0 to 1.17.0 [#148](https://github.com/nao1215/gup/pull/148) ([dependabot[bot]](https://github.com/apps/dependabot))
+ * Bump github.com/fatih/color from 1.16.0 to 1.17.0 [#148](https://github.com/nao1215/gup/pull/148) ([dependabot[bot]](https://github.com/apps/dependabot)])
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.
* Bump github.com/fatih/color from 1.16.0 to 1.17.0 [#148](https://github.com/nao1215/gup/pull/148) ([dependabot[bot]](https://github.com/apps/dependabot)) | |
* Bump github.com/fatih/color from 1.16.0 to 1.17.0 [#148](https://github.com/nao1215/gup/pull/148) ([dependabot[bot]](https://github.com/apps/dependabot)]) |
* Bump golang.org/x/sync from 0.5.0 to 0.6.0 [#130](https://github.com/nao1215/gup/pull/130) ([dependabot[bot]](https://github.com/apps/dependabot)) | ||
* Add all contributors [#129](https://github.com/nao1215/gup/pull/129) ([nao1215](https://github.com/nao1215)) | ||
* docs: add nao1215 as a contributor for code [#128](https://github.com/nao1215/gup/pull/128) ([allcontributors[bot]](https://github.com/apps/allcontributors)) | ||
* Introduce all contributors section [#127](https://github.com/nao1215/gup/pull/127) ([nao1215](https://github.com/nao1215)) |
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.
Fix the missing closing bracket for the link.
- * Introduce all contributors section [#127](https://github.com/nao1215/gup/pull/127) ([nao1215](https://github.com/nao1215))
+ * Introduce all contributors section [#127](https://github.com/nao1215/gup/pull/127) ([nao1215](https://github.com/nao1215)])
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.
* Introduce all contributors section [#127](https://github.com/nao1215/gup/pull/127) ([nao1215](https://github.com/nao1215)) | |
* Introduce all contributors section [#127](https://github.com/nao1215/gup/pull/127) ([nao1215](https://github.com/nao1215)]) |
* Add all contributors [#129](https://github.com/nao1215/gup/pull/129) ([nao1215](https://github.com/nao1215)) | ||
* docs: add nao1215 as a contributor for code [#128](https://github.com/nao1215/gup/pull/128) ([allcontributors[bot]](https://github.com/apps/allcontributors)) | ||
* Introduce all contributors section [#127](https://github.com/nao1215/gup/pull/127) ([nao1215](https://github.com/nao1215)) | ||
* Bump actions/setup-go from 4 to 5 [#126](https://github.com/nao1215/gup/pull/126) ([dependabot[bot]](https://github.com/apps/dependabot)) |
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.
Fix the missing closing bracket for the link.
- * Bump actions/setup-go from 4 to 5 [#126](https://github.com/nao1215/gup/pull/126) ([dependabot[bot]](https://github.com/apps/dependabot))
+ * Bump actions/setup-go from 4 to 5 [#126](https://github.com/nao1215/gup/pull/126) ([dependabot[bot]](https://github.com/apps/dependabot)])
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.
* Bump actions/setup-go from 4 to 5 [#126](https://github.com/nao1215/gup/pull/126) ([dependabot[bot]](https://github.com/apps/dependabot)) | |
* Bump actions/setup-go from 4 to 5 [#126](https://github.com/nao1215/gup/pull/126) ([dependabot[bot]](https://github.com/apps/dependabot)]) |
|
||
## [v0.24.1](https://github.com/nao1215/gup/compare/v0.24.0...v0.24.1) (2023-12-05) | ||
|
||
* Add remove subcommand alias: rm [#125](https://github.com/nao1215/gup/pull/125) ([nao1215](https://github.com/nao1215)) |
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.
Consider adding a determiner before "introduce".
- * introduce hottest action [#124](https://github.com/nao1215/gup/pull/124) ([nao1215](https://github.com/nao1215))
+ * Introduce the hottest action [#124](https://github.com/nao1215/gup/pull/124) ([nao1215](https://github.com/nao1215))
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.
* Add remove subcommand alias: rm [#125](https://github.com/nao1215/gup/pull/125) ([nao1215](https://github.com/nao1215)) | |
* Add remove subcommand alias: rm [#125](https://github.com/nao1215/gup/pull/125) ([nao1215](https://github.com/nao1215)) | |
* Introduce the hottest action [#124](https://github.com/nao1215/gup/pull/124) ([nao1215](https://github.com/nao1215)) |
## [v0.24.1](https://github.com/nao1215/gup/compare/v0.24.0...v0.24.1) (2023-12-05) | ||
|
||
* Add remove subcommand alias: rm [#125](https://github.com/nao1215/gup/pull/125) ([nao1215](https://github.com/nao1215)) | ||
* introduce hottest action [#124](https://github.com/nao1215/gup/pull/124) ([nao1215](https://github.com/nao1215)) |
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.
Consider using "Goodbye" instead of "Good bye".
- * Good bye BSD family [#123](https://github.com/nao1215/gup/pull/123) ([nao1215](https://github.com/nao1215))
+ * Goodbye BSD family [#123](https://github.com/nao1215/gup/pull/123) ([nao1215](https://github.com/nao1215))
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.
* introduce hottest action [#124](https://github.com/nao1215/gup/pull/124) ([nao1215](https://github.com/nao1215)) | |
* introduce hottest action [#124](https://github.com/nao1215/gup/pull/124) ([nao1215](https://github.com/nao1215)) | |
* Goodbye BSD family [#123](https://github.com/nao1215/gup/pull/123) ([nao1215](https://github.com/nao1215)) |
|
||
## [v0.24.0](https://github.com/nao1215/gup/compare/v0.23.0...v0.24.0) (2023-10-17) | ||
|
||
* Downgrade BSD test and add unit test [#114](https://github.com/nao1215/gup/pull/114) ([nao1215](https://github.com/nao1215)) |
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.
Fix the missing closing bracket for the link.
- * Downgrade BSD test and add unit test [#114](https://github.com/nao1215/gup/pull/114) ([nao1215](https://github.com/nao1215))
+ * Downgrade BSD test and add unit test [#114](https://github.com/nao1215/gup/pull/114) ([nao1215](https://github.com/nao1215)])
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.
* Downgrade BSD test and add unit test [#114](https://github.com/nao1215/gup/pull/114) ([nao1215](https://github.com/nao1215)) | |
* Downgrade BSD test and add unit test [#114](https://github.com/nao1215/gup/pull/114) ([nao1215](https://github.com/nao1215)]) |
Summary by CodeRabbit
Documentation
CODE_OF_CONDUCT.md
to emphasize respect.CONTRIBUTING.md
to highlight both coding and non-coding contributions.SECURITY.md
.CHANGELOG.md
with recent changes.Chores
.gitignore
to excludecover.*
files.Makefile
with new targets forchangelog
,tools
, andhelp
.