Skip to content

Conversation

programmer-ke
Copy link

@programmer-ke programmer-ke commented Aug 12, 2025

Closes akash-network/support#359

There are some steps that are seemingly not needed any more when setting up the repository in dev.

  • make cache does nothing, .cache directory is created on activating direnv
  • make setup is missing
  • .env file is tracked by default in the repo

Someone setting up the repo first time may therefore be confused by this.

This PR updates the CONTRIBUTING.md file to reflect the changes.

Copy link

coderabbitai bot commented Aug 12, 2025

Walkthrough

CONTRIBUTING.md updated to replace Make-based development setup with direnv steps, remove the .env copy instruction, add guidance to review and allow .envrc (which may trigger tooling/network activity), and adjust minor formatting including an EOF newline.

Changes

Cohort / File(s) Summary of Changes
Docs: CONTRIBUTING
CONTRIBUTING.md
Replace Make-based setup (remove make cache, make setup, and cp .env.example .env) with direnv workflow (direnv allow, direnv reload), add note to review ./.envrc and that activation may bootstrap tooling/network activity, minor formatting and EOF newline. No API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit checks the env with care,
"Allow .envrc — I’ll be right there!"
Direnv hums, the workflow sings,
Fewer steps and lighter springs.
Carrot in paw, I hop to share. 🥕

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between f025f64 and d6f1230.

📒 Files selected for processing (1)
  • CONTRIBUTING.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CONTRIBUTING.md
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • 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.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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

@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: 1

🧹 Nitpick comments (2)
CONTRIBUTING.md (2)

112-116: Optional: Add fish shell hook in the direnv setup section for completeness

Since you document hooks for bash and zsh, consider adding fish users’ hook to reduce setup friction.

You can add under “2. Add direnv hook to your shell:” (outside this hunk):

# For fish (add to ~/.config/fish/config.fish):
direnv hook fish | source

218-218: Remove trailing whitespace at EOF

There’s a trailing space at the end of this line. It’s harmless in Markdown but unnecessary and can distract in diffs.

Apply:

-Thank you for contributing to the Akash Network Provider! 
+Thank you for contributing to the Akash Network Provider!
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 97759f6 and f025f64.

📒 Files selected for processing (1)
  • CONTRIBUTING.md (2 hunks)

@akash-network akash-network deleted a comment from coderabbitai bot Aug 23, 2025
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.

docs: Update CONTRIBUTING.md for the provider repo

2 participants