-
Notifications
You must be signed in to change notification settings - Fork 54
docs(contributing): Update installation steps to remove missing/unused commands #312
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
base: main
Are you sure you want to change the base?
docs(contributing): Update installation steps to remove missing/unused commands #312
Conversation
WalkthroughCONTRIBUTING.md updated to replace Make-based development setup with direnv steps, remove the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
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 detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
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: 1
🧹 Nitpick comments (2)
CONTRIBUTING.md (2)
112-116
: Optional: Add fish shell hook in the direnv setup section for completenessSince 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 EOFThere’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!
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 activatingdirenv
make setup
is missing.env
file is tracked by default in the repoSomeone setting up the repo first time may therefore be confused by this.
This PR updates the CONTRIBUTING.md file to reflect the changes.