Thank you for your interest in contributing to Akash Network! This guide will help you get started with contributing to the codebase, documentation, and community.
Ways to Contribute
Code Contributions
Contribute to Akash’s open-source projects:
- node - Akash blockchain node
- provider - Provider services
- console - Akash Console (web UI)
- website - Documentation (this site!)
- awesome-akash - Community deployment examples
Documentation Contributions
Improve documentation for all users:
- Fix typos and errors
- Add missing information
- Update outdated content
- Write new guides
- Add code examples
- Improve clarity
See: Documentation Writing Guide
Community Contributions
Help others in the community:
- Answer questions in Discord
- Share your deployment examples
- Write blog posts or tutorials
- Help test new features
- Report bugs and issues
Getting Started
1. Choose Your Contribution Type
Code:
- Console & Website Setup - Web development (recommended for beginners)
- Node & Provider Setup - Blockchain development (advanced)
- Code Conventions
- Pull Request Process
Documentation:
Community:
- Join Discord
- Explore Awesome Akash
- Read the Blog
2. Set Up Your Environment
For code contributions:
- Clone the relevant repository
- Set up your development environment
- Run tests to verify setup
For documentation contributions:
- Clone the website repository
- Follow Console & Website Setup
- Run
npm installandnpm run devto preview locally
3. Find Something to Work On
Browse open issues:
- Node & Provider Issues - All node and provider issues
- Console Issues - Web UI issues
- Documentation Issues - Docs issues
- Awesome Akash - Add deployment examples
Good first issues:
- Look for issues labeled
good first issueorready-for-community-dev - Documentation improvements (typos, missing info, unclear sections)
- Simple bug fixes
- Adding SDL examples to Awesome Akash
Ask for guidance:
- Discord: #developers channel
- GitHub: Comment on issues you’re interested in
- Don’t hesitate to ask questions!
Contribution Guidelines
Before You Start
- Check existing issues - Someone might already be working on it
- Discuss major changes - Open an issue or ask in Discord first
- Read the guidelines - Follow code conventions and documentation style
- Test your changes - Ensure everything works before submitting
Making Changes
- Fork the repository (for external contributors)
- Create a branch - Use descriptive names:
fix/typo-in-provider-docs - Make your changes - Follow conventions for the project
- Test thoroughly - Run tests, verify builds pass
- Commit with clear messages - Follow conventional commit format
Submitting Changes
- Open a pull request - Describe what you changed and why
- Link related issues - Use keywords:
Fixes #123 - Respond to feedback - Address reviewer comments
- Be patient - Reviews may take time
Commit Message Format
Use conventional commit format:
<type>: <summary>
<body (optional)>Types:
feat:- New featuresfix:- Bug fixesdocs:- Documentation changeschore:- Maintenance taskstest:- Test updatesrefactor:- Code refactoring
Examples:
feat: add GPU support to provider
fix: correct gas price in validator guide
docs: update hardware requirements for providers
chore: bump dependency versionsCode of Conduct
Be Respectful
- Treat everyone with respect
- Welcome newcomers
- Be patient with questions
- Provide constructive feedback
Be Collaborative
- Share knowledge freely
- Help others succeed
- Work together on solutions
- Celebrate contributions
Be Professional
- Focus on the work, not the person
- Accept constructive criticism
- Learn from mistakes
- Improve continuously
Getting Help
Where to Ask
For code questions:
- Discord: #developers channel
- GitHub: Open an issue or discussion
For documentation questions:
- Discord: #docs channel (if exists) or #developers
- GitHub: website issues
For general questions:
- Discord: #general or #support
- Community Resources
Support Workflow
- Ask in Discord first - Fastest response
- Search existing issues - Your question might be answered
- Open a GitHub issue - If unresolved and needs tracking
- Be specific - Provide context, logs, and steps to reproduce
Recognition
Contributors Are Valued
Your contributions are appreciated:
- All contributors are acknowledged in release notes
- Significant contributions are highlighted in blog posts
- Active contributors become trusted community members
- Outstanding contributors may join core teams
Building Your Portfolio
Contributing to Akash:
- Demonstrates blockchain development skills
- Shows open-source collaboration experience
- Builds your GitHub profile
- Connects you with the Akash community
- May lead to career opportunities
Next Steps
Ready to contribute?
-
Pick a section:
- Getting Started
- Console & Website Setup - For web development
- Node & Provider Setup - For blockchain development
- Documentation Guide
- Code Conventions
- Pull Request Process
-
Join the community:
-
Start contributing:
- Find a good first issue
- Ask questions in Discord
- Submit your first PR!
Related Resources
Questions? Join us on Discord - the community is here to help!
