chore: General cleanup tasks

[tankerkiller125]

What type of PR is this?

• cleanup

What this PR does / why we need it:

Removed legacy stuff from the hay-kot repo that we don't use, and never will, also updates the PR template to remove sections were unlikely to use (mostly because the AI bot does it for us) and finally updates the docs to note a change in the default behavior regarding durations for the web timeout variables.

Summary by CodeRabbit

• Documentation

  • Updated SECURITY.md to distinguish between reporting minor/general and major/critical security vulnerabilities.
  • Revised docs/en/quick-start.md to specify time units for environment variable configurations and added a warning on appending time units.

• Chores

  • Simplified the pull request template by removing sections on testing and release notes.

[coderabbitai]

Warning

Review failed

Failed to post review comments.

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a93f4ff and b5df188.

Files selected for processing (3)

• .github/pull_request_template.md (1 hunks)
• SECURITY.md (1 hunks)
• docs/en/quick-start.md (2 hunks)

Additional context used

Markdownlint

SECURITY.md

11-11: null
Files should end with a single newline character

(MD047, single-trailing-newline)

docs/en/quick-start.md

48-48: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

LanguageTool

docs/en/quick-start.md

[typographical] ~74-~74: Do not use a colon (:) before a series that is introduced by a preposition (‘of’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ... | log format to use, can be one of: text, json ...

(RP_COLON)

---

[grammar] ~75-~75: This phrase contains a double negative, or a comma may be missing.
Context: ... | email host to use, if not set no email provider will be used ...

(DOUBLE_NEGATIVE)

Additional comments not posted (2)

docs/en/quick-start.md (2)

65-65: Correct the typographical error.

Add a hyphen to "auto-increments" for clarity.

- HBOX_OPTIONS_AUTO_INCREMENT_ASSET_ID | true                   | auto increments the asset_id field for new items
+ HBOX_OPTIONS_AUTO_INCREMENT_ASSET_ID | true                   | auto-increments the asset_id field for new items

---

68-70: Clarify the description of timeout variables.

Ensure the descriptions of the timeout variables are clear and consistent.

- | HBOX_WEB_READ_TIMEOUT                | 10s                    | Read timeout of HTTP sever                                                         |
- | HBOX_WEB_WRITE_TIMEOUT               | 10s                    | Write timeout of HTTP server                                                       |
- | HBOX_WEB_IDLE_TIMEOUT                | 30s                    | Idle timeout of HTTP server                                                        |
+ | HBOX_WEB_READ_TIMEOUT                | 10s                    | Read timeout of HTTP server                                                        |
+ | HBOX_WEB_WRITE_TIMEOUT               | 10s                    | Write timeout of HTTP server                                                       |
+ | HBOX_WEB_IDLE_TIMEOUT                | 30s                    | Idle timeout of HTTP server                                                        |

Comments failed to post (4)

SECURITY.md

9-9: Ensure consistency in terminology.

The term "inquires" should be corrected to "inquiries" for proper spelling.

- Please open a normal public issue for minor security issues or general security inquires.
+ Please open a normal public issue for minor security issues or general security inquiries.

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.

Please open a normal public issue for minor security issues or general security inquiries.

---

11-11: Add a newline at the end of the file.

Files should end with a single newline character to avoid issues with certain tools and version control systems.

- For major or critical security issues, please open a private github security issue.
+ For major or critical security issues, please open a private github security issue.
+

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.

For major or critical security issues, please open a private github security issue.

Tools

Markdownlint

11-11: null
Files should end with a single newline character

(MD047, single-trailing-newline)

.github/pull_request_template.md

58-58: Remove the unnecessary colon.

Do not use a colon before a series introduced by a preposition.

- Describe how you tested this change.
+ Describe how you tested this change

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.

-->
Describe how you tested this change

docs/en/quick-start.md

53-55: Enhance readability with proper punctuation.

The sentence contains multiple clauses that require commas for clarity.

- If you have previously set up docker compose with the `HBOX_WEB_READ_TIMEOUT`, `HBOX_WEB_WRITE_TIMEOUT`, or `HBOX_IDLE_TIMEOUT` options, and you were previously using the hay-kot image, please note that you will have to add an `s` for seconds or `m` for minutes to the end of the integers. A dependency update removed the defaultation to seconds and it now requires an explicit duration time.
+ If you have previously set up docker compose with the `HBOX_WEB_READ_TIMEOUT`, `HBOX_WEB_WRITE_TIMEOUT`, or `HBOX_IDLE_TIMEOUT` options, and you were previously using the hay-kot image, please note that you will have to add an `s` for seconds or `m` for minutes to the end of the integers. A dependency update removed the default setting to seconds, and it now requires an explicit duration time.

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.

::: warning
If you have previously set up docker compose with the `HBOX_WEB_READ_TIMEOUT`, `HBOX_WEB_WRITE_TIMEOUT`, or `HBOX_IDLE_TIMEOUT` options, and you were previously using the hay-kot image, please note that you will have to add an `s` for seconds or `m` for minutes to the end of the integers. A dependency update removed the default setting to seconds, and it now requires an explicit duration time.
:::

Walkthrough

Walkthrough

High-Level Summary:

Recent updates encompass improvements to security reporting protocols, environment variable configurations, and simplification of the pull request template. Adjustments to timeout settings necessitate explicit time units to comply with dependency changes, and security vulnerability reporting instructions have been refined for clarity.

Changes

File	Change Summary
.github/pull_request_template.md	Removed sections related to describing testing procedures and release notes.
SECURITY.md	Updated instructions for reporting security vulnerabilities, distinguishing between minor/general issues and major/critical issues.
docs/en/quick-start.md	Specified time units (seconds) for environment variables: HBOX_WEB_READ_TIMEOUT, HBOX_WEB_WRITE_TIMEOUT, and HBOX_WEB_IDLE_TIMEOUT. Added warning about appending s for seconds or m for minutes to values.

Poem

In the realm of code, a shift so wise,
Timeouts now clear, with explicit ties.
Security paths, distinctly shown,
Minor's public, major's unknown.
Templates trimmed, succinct and neat,
A coder's world, with changes sweet.
Progress flows, in lines so fleet. 🚀

Would you like any additional information synthesized, Sir?

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @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.

[coderabbitai]

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a93f4ff and 5568b38.

Files selected for processing (2)

• .github/pull_request_template.md (1 hunks)
• docs/en/quick-start.md (2 hunks)

Files skipped from review due to trivial changes (1)

• .github/pull_request_template.md

Additional context used

LanguageTool

docs/en/quick-start.md

[uncategorized] ~54-~54: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ..._TIMEOUTorHBOX_IDLE_TIMEOUT` options and you were previously using the hay-kot i...

(COMMA_COMPOUND_SENTENCE)

---

[typographical] ~54-~54: Consider adding a comma here.
Context: ... were previously using the hay-kot image please note that you will have to add an s f...

(PLEASE_COMMA)

---

[uncategorized] ~54-~54: Possible missing comma found.
Context: ...ency update removed the defaultation to seconds and it now requires an explicit duratio...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[uncategorized] ~65-~65: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...ENT_ASSET_ID | true | auto increments the asset_id field for new items ...

(AUTO_HYPHEN)

---

[typographical] ~73-~73: Do not use a colon (:) before a series that is introduced by a preposition (‘of’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ... | log level to use, can be one of: trace, debug, info, warn, error, critic...

(RP_COLON)

Markdownlint

docs/en/quick-start.md

48-48: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

Additional comments not posted (1)

docs/en/quick-start.md (1)

68-70: LGTM!

The changes to add time units to the timeout variables improve clarity and correctness.

[cloudflare-workers-and-pages]

Deploying homebox-docs with    Cloudflare Pages

Latest commit:	b5df188
Status:	✅  Deploy successful!
Preview URL:	https://2a956e70.homebox-docs.pages.dev
Branch Preview URL:	https://tank-cleanup.homebox-docs.pages.dev

View logs

[tankerkiller125]

@coderabbitai full review

[coderabbitai]

Actions performed

Full review triggered.

[tankerkiller125]

@coderabbitai full review

[coderabbitai]

Actions performed

Full review triggered.

[tankerkiller125]

@katosdev When you get a chance... Apparently the bot is broken for some reason.