🤝 CONTRIBUTING TO AZORA OS

November 23, 2025 · View on GitHub

Ubuntu Philosophy: "I am because we are"

🌟 WELCOME

Thank you for your interest in contributing to Azora OS! Your contributions strengthen our collective foundation and multiply prosperity for all.

🎯 WAYS TO CONTRIBUTE

1. Code Contributions

Fix bugs and issues
Add new features
Improve performance
Enhance security
Write tests

2. Documentation

Improve existing docs
Write tutorials
Create examples
Translate content
Fix typos

3. Design

UI/UX improvements
Accessibility enhancements
Visual assets
Brand materials

4. Community

Answer questions
Review pull requests
Mentor newcomers
Share knowledge
Report issues

🚀 GETTING STARTED

1. Fork & Clone

# Fork on GitHub, then:
git clone https://github.com/YOUR_USERNAME/azora-os.git
cd azora-os

2. Install Dependencies

npm install --legacy-peer-deps

3. Create Branch

git checkout -b feature/your-feature-name

4. Make Changes

Follow code style
Write tests
Update docs
Ensure constitutional compliance

5. Test

npm test
./check-constitution.sh

6. Commit

git add .
git commit -m "feat: your feature description"

7. Push & PR

git push origin feature/your-feature-name
# Create Pull Request on GitHub

📋 CONTRIBUTION GUIDELINES

Code Style

Use TypeScript for type safety
Follow existing patterns
Write clear comments
Use meaningful names
Keep functions small

Commit Messages

We follow Conventional Commits format for clear, searchable git history.

Format: type(scope): subject

Types:

feat: New feature
fix: Bug fix
docs: Documentation
style: Formatting (no code change)
refactor: Code restructuring
perf: Performance improvement
test: Tests
build: Build system changes
ci: CI/CD changes
chore: Maintenance
revert: Revert previous commit
ubuntu: Ubuntu philosophy integration

Scopes:

education: Education services
finance: Finance/payment services
marketplace: Marketplace features
security: Security features
infrastructure: Infrastructure changes
ai-family: AI family services
governance: Governance features
docs: Documentation
deps: Dependency updates

Examples:

# New feature
git commit -m "feat(education): add AI tutor personality system"

# Bug fix
git commit -m "fix(finance): resolve payment processing timeout"

# Documentation
git commit -m "docs: update API authentication guide"

# Performance improvement
git commit -m "perf(infrastructure): optimize database query caching"

# With body (for complex changes)
git commit -m "feat(education): add AI tutor personality system

- Implement personality engine with 5 core traits
- Add trait persistence to database
- Create personality configuration UI
- Fixes #123"

Rules:

Capitalize subject line
Use imperative mood ("add" not "added")
Don't end subject with period
Limit subject to 100 characters
Separate subject from body with blank line
Use body to explain what and why, not how
Reference issues: "Fixes #123" or "Closes #456"

Pull Requests

Clear title and description
Link related issues
Include tests
Update documentation
Pass all checks

🛡️ CONSTITUTIONAL COMPLIANCE

All contributions must comply with the Azora Constitution:

No Mock Protocol ✅

No mock data or services
No stubs or placeholders
No fake implementations
Production-ready code only

Truth as Currency ✅

Accurate information
Verifiable claims
Transparent operations
No misinformation

Ubuntu Philosophy ✅

Collective benefit focus
Inclusive design
Accessible to all
Community-driven

Privacy by Design ✅

Protect user data
Minimize collection
Secure storage
Transparent usage

🧪 TESTING

Run Tests

# All tests
npm test

# Specific suite
npm run test:unit
npm run test:integration
npm run test:e2e

# Constitutional compliance
./check-constitution.sh