Start Contributing to Autonomys
Welcome to the heart of open-source collaboration! The Autonomys Network thrives because of contributors like you who bring fresh ideas, spot improvements, and help build the future of decentralized infrastructure. Whether you're fixing a typo or implementing a new feature, every contribution matters.
Why Contribute?
Contributing to Autonomys isn't just about code. It's about being part of a movement to decentralize the internet's infrastructure. When you contribute:
- Shape the Future: Your ideas and improvements directly impact how thousands of users interact with the network
- Learn and Grow: Gain hands-on experience with cutting-edge blockchain technology
- Join a Community: Connect with developers, farmers, and enthusiasts from around the world
- Build Your Portfolio: Open source contributions showcase your skills to potential employers
- Make a Difference: Help create a more decentralized and equitable internet
Ways to Make an Impact
Improve Documentation
Fix typos, clarify concepts, add examples
Write Guides
Share tutorials and best practices
Report Issues
Help us maintain quality
Submit Features
Suggest new improvements
Translate Documentation
Help make docs accessible globally
Build & Share Tools
Create tools for the community
Quick Start Guide
Choose your contribution path based on your comfort level and goals:
- Simple Edits
- Advanced Setup
Perfect for first-time contributors! Make quick improvements directly in your browser—no technical setup required.
What you can do:
- Fix typos and grammar
- Improve clarity and readability
- Update outdated information
- Add missing details
How to contribute:
- Navigate to any page in the documentation
- Scroll to the bottom and click "Edit this page"
- Make your changes in GitHub's web editor
- Write a clear commit message describing your changes
- Click "Propose changes" and then "Create pull request"
Your changes will be automatically saved to a fork of the repository. Our maintainers will review and merge your contribution, usually within 1-2 days.
For substantial contributions like new pages, features, or major restructuring.
Prerequisites:
- Git and GitHub account
- Node.js v22 or higher
- Text editor or IDE (VS Code recommended)
- Basic command line knowledge
Setup instructions:
# 1. Fork the repository on GitHub
# 2. Clone your fork
git clone https://github.com/YOUR-USERNAME/subspace-docs.git
cd subspace-docs
# 3. Install dependencies
npm install
# or
yarn install
# 4. Start development server
npm run start
# or
yarn start
# 5. Open http://localhost:3000 in your browser
Contribution workflow:
- Create a new branch:
git checkout -b feature/your-feature-name
- Make your changes and test locally
- Commit with descriptive messages:
git commit -m "Add: description of changes"
- Push to your fork:
git push origin feature/your-feature-name
- Open a pull request on GitHub
Check out our README for detailed setup instructions.
Contribution Guidelines
Quality Standards
To maintain high-quality documentation:
- Be Clear: Use simple language and avoid unnecessary jargon
- Be Accurate: Verify technical details and test code examples
- Be Consistent: Follow existing patterns and conventions
- Be Complete: Include all necessary information without being verbose
- Be Helpful: Think from the reader's perspective
Before You Submit
- Test all links and code snippets
- Run
npm run build
to ensure no build errors - Review your changes for typos and formatting
- Write a clear PR title and description
- Reference any related issues (e.g., "Fixes #123")
Code Comments
When contributing code or complex examples:
// Don't comment obvious code
const name = "Autonomys"; // Sets name to Autonomys
// Do comment complex logic
// Calculate expected rewards based on pledged space and network difficulty
// Uses the formula: rewards = (pledgedSpace / totalNetworkSpace) * blockRewards
function calculateExpectedRewards(pledgedSpace, networkStats) {
// Implementation here
}
Join Our Community
Contributing is more rewarding when you're connected with fellow builders. Join us:
Discord Server
Chat with contributors
Community Forum
Share ideas and guides
GitHub Organization
Explore all repositories
Getting Help
- Quick questions: Ask in the
#developer-chat
channel on Discord - Documentation help: Post in
#docs-discussion
- Technical issues: Open a GitHub issue with details
- General support: Visit the forum's support section
Remember to follow our Code of Conduct in all interactions.
Ready to Make Your Mark?
Every expert was once a beginner. Start small, ask questions, and don't be afraid to make mistakes. The Autonomys community is here to support your journey!
Check out these beginner-friendly resources:
- First Contributions Guide - Step-by-step tutorial
- How to Contribute to Open Source - Comprehensive guide
- Understanding GitHub Flow - GitHub's workflow explained