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

Update project config #149

Merged
merged 1 commit into from
May 15, 2024
Merged

Update project config #149

merged 1 commit into from
May 15, 2024

Conversation

nao1215
Copy link
Owner

@nao1215 nao1215 commented May 15, 2024

Summary by CodeRabbit

  • Documentation

    • Updated funding options and removed Patreon.
    • Simplified bug report template title.
    • Overhauled CODE_OF_CONDUCT.md to emphasize respect.
    • Reorganized CONTRIBUTING.md to highlight both coding and non-coding contributions.
    • Added security policy in SECURITY.md.
    • Updated CHANGELOG.md with recent changes.
  • Chores

    • Updated Go versions for testing in GitHub Actions.
    • Broadened .gitignore to exclude cover.* files.
    • Enhanced Makefile with new targets for changelog, tools, and help.

Copy link
Contributor

coderabbitai bot commented May 15, 2024

Walkthrough

The 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 .gitignore patterns, and overhauling the code of conduct and contribution guidelines. Additionally, the Makefile has new targets, and a security policy has been introduced.

Changes

File Path Change Summary
.github/FUNDING.yml Removed patreon option and updated github funding to nao1215.
.github/ISSUE_TEMPLATE/bug_report.md Removed placeholder text "XXX" from the title field.
.github/workflows/multi_ver_unittest.yml Updated go-version matrix from ["1.19", "1.22"] to ["1.20", "1.22"].
.gitignore Changed cover.html to cover.* to exclude more files.
CHANGELOG.md Documented version updates, dependency bumps, bug fixes, feature additions, and improvements.
CODE_OF_CONDUCT.md Replaced entire content with a concise message about respect.
CONTRIBUTING.md Reorganized content, focusing on broader support actions beyond technical contributions.
Makefile Added targets changelog, tools, help, and updated PHONY list.
SECURITY.md Introduced a security policy detailing how to report vulnerabilities and handling security issues.

🐇
Amidst the code, a rabbit's cheer,
For changes made both far and near.
From funding shifts to conduct clear,
Contributions now bring broader cheer.
With Go versions set to test and steer,
Our project grows, no bugs to fear.
🌿


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

HOTTEST report

PASS FAIL SKIP TOTAL DURATION
147 0 0 147 2.907691868s

Reported by hottest

Copy link
Contributor

Code Metrics Report

main (e37150f) #149 (eab1224) +/-
Coverage 77.5% 77.5% 0.0%
Test Execution Time 17s 4s -13s
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

@nao1215 nao1215 merged commit 2e97863 into main May 15, 2024
11 checks passed
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits Files that changed from the base of the PR and between e37150f and 2c477be.
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 the PHONY list is correct and improves the Makefile.

@@ -1,141 +1,11 @@
<!-- omit in toc -->
## Contributing as a Developer
Copy link
Contributor

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.

Suggested change
## 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
Copy link
Contributor

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.

Suggested change
## 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.
Copy link
Contributor

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.

Suggested change
- 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)
Copy link
Contributor

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.

Suggested change
## [](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))
Copy link
Contributor

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.

Suggested change
* 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))
Copy link
Contributor

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.

Suggested change
* 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))
Copy link
Contributor

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.

Suggested change
* 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))
Copy link
Contributor

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.

Suggested change
* 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))
Copy link
Contributor

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.

Suggested change
* 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))
Copy link
Contributor

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.

Suggested change
* 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)])

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.

1 participant