Contributing
Welcome to The Altar
"The future is built on ideas. Your code is just another form of creativity."
We welcome contributions from developers, creators, and visionaries who want to help build the future of human-AI collaboration. Whether you're fixing bugs, building features, or improving documentation, your contributions shape The Altar's evolution.
π Quick Start
Repository Structure
altar-of-creativity/
βββ miniapp/ # Telegram Mini-App frontend
βββ api/ # Backend API services
βββ contracts/ # Smart contracts
βββ ai-scorer/ # AI scoring service
βββ docs/ # Documentation
βββ tools/ # Development utilities
Development Setup
# Clone the repository
git clone https://github.com/altar-of-creativity/miniapp
cd miniapp
# Install dependencies
npm install
# Start development server
npm run dev:miniapp
# Run tests
npm test
# Build for production
npm run build
π Code Contribution Guidelines
Branch Naming Convention
feature/description # New features
bugfix/description # Bug fixes
hotfix/description # Critical fixes
docs/description # Documentation
refactor/description # Code improvements
Commit Message Format
<type>(<scope>): <description>
Types:
β¨ feat: New feature
π fix: Bug fix
π docs: Documentation
π¨ style: Code style changes
β»οΈ refactor: Code refactoring
β‘ perf: Performance improvements
β
test: Adding tests
π§ chore: Maintenance
Code Quality Standards
ESLint & Prettier Configuration:
{
"extends": ["@altar/eslint-config"],
"rules": {
"no-console": "warn",
"prefer-const": "error",
"react-hooks/exhaustive-deps": "error"
}
}
TypeScript Requirements:
Strict mode enabled
Explicit return types for functions
Proper interface definitions
No
any
types without justification
Testing Standards
// Example test structure
describe('CreativityScorer', () => {
it('should score original ideas highly', async () => {
const scorer = new CreativityScorer();
const result = await scorer.score("Revolutionary AI concept");
expect(result.score).toBeGreaterThan(80);
});
});
π οΈ Areas We're Looking For Help
Frontend Development
Mini-App Enhancement:
React component optimization
Mobile-first responsive design
Telegram WebApp SDK integration
Performance improvements
Accessibility features
Skills Needed:
React 18+ & TypeScript
Telegram Bot API experience
Mobile-first CSS/Tailwind
Framer Motion animations
PWA implementation
Backend Development
API & Infrastructure:
Node.js/Express optimization
Database query performance
Authentication systems
Rate limiting & security
WebSocket real-time features
Skills Needed:
Node.js & Express
PostgreSQL/Redis
JWT authentication
Docker containerization
AWS/GCP deployment
AI & Machine Learning
Scoring System Enhancement:
Embedding model improvements
Fact-checking accuracy
Multilingual support
Bias detection systems
Performance optimization
Skills Needed:
Python & TensorFlow/PyTorch
NLP & text processing
Vector databases
MLOps practices
Model deployment
Blockchain Development
Smart Contract Work:
Gas optimization
Security improvements
Cross-chain compatibility
Governance mechanisms
Token economics
Skills Needed:
Solidity & Hardhat
DeFi protocols
Security auditing
Layer 2 solutions
Web3 integration
π‘ Ideas We're Looking For
From The Temple of Thought
High-reward contributions aligned with our mission:
π§ Raw Ideas (Foundation Level)
Creative submission formats
User experience improvements
Community engagement features
Onboarding optimizations
π AI Filter (Processing Level)
Scoring algorithm enhancements
Content moderation systems
Originality detection improvements
Fact-checking integrations
π Rewards (Apex Level)
Token distribution mechanisms
Staking system optimization
Governance voting systems
Cross-platform integrations
π Development Workflow
Pull Request Process
Fork the repository
Create feature branch from
develop
Implement changes with tests
Ensure CI/CD passes
Submit PR with description
Respond to review feedback
Merge after approval
Code Review Standards
Required Checks:
β All tests pass
β Code coverage >80%
β ESLint/Prettier compliance
β TypeScript type checking
β Security scan passes
Review Focus:
Code quality and maintainability
Performance implications
Security considerations
User experience impact
Documentation completeness
π Bounty Program
Contribution Rewards
π° $AION Token Rewards:
Major Feature: 1,000-5,000 $AION
Bug Fix: 100-500 $AION
Documentation: 50-200 $AION
Code Review: 25-100 $AION
Special Recognition
π Contributor Status:
Core Contributor: 10+ merged PRs
AI Specialist: ML/AI contributions
Security Expert: Security improvements
Community Leader: Documentation/support
π Community Guidelines
Code of Conduct
Our Values:
Respect: All contributors are valued
Collaboration: Working together effectively
Quality: Maintaining high standards
Innovation: Pushing boundaries responsibly
Communication Channels
GitHub Issues: Bug reports and feature requests
Discord: Development discussions
Telegram: Community chat
Email: security@altarofcreativity.com
Documentation Standards
Every PR should include:
Clear description of changes
Updated documentation
Test coverage information
Breaking change notifications
π Getting Started Today
First-Time Contributors
Browse good first issues
Join our Discord
Read the technical documentation
Start with small improvements
Experienced Developers
Review architecture documentation
Explore advanced feature requests
Discuss complex implementations
Lead feature development
Community Leaders
Improve documentation
Answer community questions
Mentor new contributors
Organize development initiatives
Ready to contribute? View Open Issues β
Need help? Join our Discord Community β
Have ideas? Submit to The Altar β
Last updated