Contributing to AnswerAI
Welcome to the AnswerAI Alpha Sprint! This guide will help you contribute effectively to our mission of building privacy-first AI tools.
π Getting Startedβ
1. Choose Your Repositoryβ
Visit our organization repositories and pick a project:
- theanswer - Main platform (21kβ)
- aai-browser-sidekick - Chrome extension
- FlowiseChatEmbed - Chat embedding (1.5kβ)
- mcp-inspector - MCP testing tool
- Various MCP servers - HubSpot, Jira, Confluence integrations
2. Find Your First Issueβ
Look for issues tagged with:
beginner
- Perfect for first-time contributorsgood first issue
- Well-documented starter taskshelp wanted
- Community assistance neededalpha-sprint
- High-priority for July 21st deadline
π PR Processβ
Before You Startβ
- Fork the repository you want to contribute to
- Clone your fork locally
- Create a new branch for your feature/fix
- Read the existing code to understand patterns
Development Workflowβ
# Clone your fork
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
cd REPO_NAME
# Create feature branch
git checkout -b feature/your-feature-name
# Install dependencies
npm install
# or
pnpm install
# Start development server
npm run dev
Making Changesβ
- Follow existing code style - We use ESLint and Prettier
- Write descriptive commit messages
- Test your changes thoroughly
- Update documentation if needed
Commit Message Formatβ
Use conventional commit format:
type: brief description
feat: add new chat sidekick for data analysis
fix: resolve extension popup sizing issue
docs: update API documentation for agents
style: format code according to prettier rules
refactor: improve database query performance
test: add unit tests for chat history
Pull Request Guidelinesβ
1. Create a Quality PRβ
- Title: Clear, descriptive summary
- Description: Explain what you built and why
- Screenshots: For UI changes
- Testing: How you verified it works
2. PR Templateβ
## What I Built
Brief description of your contribution
## Problem It Solves
Explain the specific issue or enhancement
## How It Serves the Mission
Connect to our privacy-first, developer-friendly goals
## Testing Done
- [ ] Local testing completed
- [ ] Edge cases considered
- [ ] Documentation updated
## Screenshots/Video
[Include visual proof of your work]
## Additional Notes
Any special considerations or future improvements
3. Automated Review Processβ
Our system will automatically:
- β Run tests and linting
- π€ Provide AI-suggested improvements
- π Check code coverage
- π Security vulnerability scan
4. Video Requirementβ
Every merged PR requires a 1-3 minute video explaining:
- What you built/fixed
- Problem it solves
- How it serves our mission
- Demo of functionality
Video Guidelinesβ
- Length: 1-3 minutes maximum
- Format: MP4, MOV, or YouTube link
- Quality: Clear audio, visible screen
- Content: Focus on your contribution's impact
π― Contribution Typesβ
Code Contributionsβ
- Bug fixes - Resolve existing issues
- New features - Enhance platform capabilities
- Performance - Optimize speed and efficiency
- Security - Strengthen privacy and safety
Non-Code Contributionsβ
- Documentation - Improve guides and examples
- Testing - Write and improve test coverage
- Design - UI/UX improvements
- Community - Help other contributors
π Recognition Systemβ
Credit Earning Tiersβ
π₯ Bronze Contributors
- First merged PR
- Community recognition
- Alpha sprint certificate
π₯ Silver Contributors
- 5+ merged PRs
- Technical mentor status
- Early access to new features
π₯ Gold Contributors
- 10+ merged PRs
- Architecture decision input
- Revenue sharing opportunities
β‘ Alpha Sprint Prioritiesβ
High-Priority Areasβ
-
Chrome Extension Polish
- Performance optimizations
- Bug fixes
- New tool integrations
-
Web Application Features
- Chat improvements
- Agent management
- Studio enhancements
-
Foundation Work
- Desktop app architecture
- API improvements
- Documentation
Special Recognitionβ
Alpha Sprint Heroes get:
- Direct access to core team
- Influence on roadmap decisions
- First access to revenue sharing
- Speaking opportunities at events
π οΈ Development Environmentβ
Required Toolsβ
- Node.js (18.15.0+ or 20+)
- pnpm (recommended) or npm
- Git with SSH keys configured
- VS Code (recommended) with extensions:
- ESLint
- Prettier
- TypeScript Hero
Environment Setupβ
# Install dependencies
pnpm install
# Copy environment template
cp .env.example .env
# Start development servers
pnpm dev
Testingβ
# Run all tests
pnpm test
# Run specific test suite
pnpm test:unit
pnpm test:e2e
# Watch mode for development
pnpm test:watch
π€ Code Review Processβ
What We Look Forβ
-
Code Quality
- Clean, readable code
- Proper error handling
- Performance considerations
-
Alignment with Mission
- Privacy-first approach
- User empowerment
- Developer-friendly design
-
Community Impact
- Solves real problems
- Enhances user experience
- Moves sprint goals forward
Review Timelineβ
- Initial response: Within 24 hours
- Full review: Within 48 hours
- Merge decision: Within 72 hours
π After Your PR is Mergedβ
- Record your video (if not done already)
- Share on social media with #AnswerAIAlphaSprint
- Find your next issue to continue contributing
- Help other contributors in discussions
π¬ Getting Helpβ
Community Supportβ
- Discord: Join our developer community
- GitHub Discussions: Ask questions in repo discussions
- Office Hours: Weekly developer Q&A sessions
Direct Supportβ
- Stuck on setup? Tag
@core-team
in discussions - Architecture questions? Create detailed GitHub issue
- Urgent blockers? Message in #alpha-sprint Discord channel
π Sprint Timelineβ
Now - July 21st, 2025
- Core development phase
- Daily progress updates
- Weekly community calls
July 21st
- Alpha release celebration
- Contributor recognition event
- Roadmap for post-alpha development
Remember: We're not just building softwareβwe're proving that committed developers can create better tools than billion-dollar corporations. Every contribution matters in showing the world what privacy-first, developer-owned AI looks like.
Ready to start building? Browse our repositories and find your first issue!