fix: golangci and markdown lint errors

[MSevey]

golangci-lint uses v1.59 in the ci so developers need to ensure they have 1.59+ installed locally to catch lint errors.

Fixes: https://github.com/rollkit/rollkit/actions/runs/9260526579/job/25474463023

Summary by CodeRabbit

• Documentation

  • Reorganized sections and improved formatting in the README for better clarity.

• Bug Fixes

  • Enhanced error handling in the version command output to ensure errors are captured and reported properly.

[coderabbitai]

Walkthrough

The recent updates enhance configuration and documentation clarity while improving error handling. Specifically, .golangci.yml now uses exclude-dirs for better directory management, README.md undergoes minor formatting and section reordering, and cmd/rollkit/commands/version.go improves error aggregation in version command output.

Changes

Files	Change Summary
.golangci.yml	Replaced skip-dirs with exclude-dirs under issues, targeting mempool, state/indexer, state/txindex, and third_party.
README.md	Minor formatting adjustments and section reordering in usage instructions, contribution guidelines, and audit information.
cmd/rollkit/commands/version.go	Modified VersionCmd to capture and aggregate errors from fmt.Fprintf and fmt.Fprintln before returning.

In code's vast and winding maze,
We tweak and mend in subtle ways.
Directories now better aligned,
Documentation redefined.
Errors caught, no longer stray,
Rollkit's version leads the way.
🐇✨

---

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 full the 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: 0

Outside diff range and nitpick comments (1)

README.md (1)

Line range hint 66-66: Consider reducing the number of exclamation marks to maintain a professional tone in the documentation.

- ... way to find something you can help with!
+ ... way to find something you can help with.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b47ad9b and 7290685.

Files selected for processing (3)

• .golangci.yml (2 hunks)
• README.md (3 hunks)
• cmd/rollkit/commands/version.go (1 hunks)

Additional Context Used

LanguageTool (1)

README.md (1)

Near line 66: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 2975 characters long)
Context: ... way to find something you can help with! See [the contributing guide](https://g...
Rule ID: EN_EXCESSIVE_EXCLAMATION

Additional comments not posted (3)

cmd/rollkit/commands/version.go (1)

32-35: Improved error handling in VersionCmd by aggregating errors before returning.

.golangci.yml (1)

24-29: Updated lint configuration to exclude specific directories.

Verification successful

---

The directories listed under exclude-dirs in the .golangci.yml file are correctly configured and exist in the repository.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify that the excluded directories are correctly configured in the `.golangci.yml`.

# Test: Check the `.golangci.yml` for the presence of the `exclude-dirs` setting and its values.
cat .golangci.yml | grep -A 5 'exclude-dirs'

Length of output: 143

---

---

Script:

#!/bin/bash
# Description: Verify the existence of directories listed under `exclude-dirs` in the repository.

# Directories to check
directories=(
  "mempool"
  "state/indexer"
  "state/txindex"
  "third_party"
)

# Check if each directory exists
for dir in "${directories[@]}"; do
  if [ -d "$dir" ]; then
    echo "Directory exists: $dir"
  else
    echo "Directory does not exist: $dir"
  fi
done

Length of output: 579

README.md (1)

107-109: Updated the audits table to include recent audits.

[tuxcanfly]

OK.