Contributing
Guide to contributing to Arg0 Desktop.
Overview
Thank you for your interest in contributing to Arg0 Desktop! This guide will help you get started with contributing to the project.
Getting Started
Prerequisites
- Node.js (v18 or higher)
- npm or yarn
- Git
- Basic knowledge of TypeScript, React, and Electron
Setup Development Environment
-
Fork the repository:
bash# Fork the repository on GitHub # Clone your fork git clone https://github.com/your-username/synapse_desktop.git cd synapse_desktop -
Install dependencies:
bashnpm install -
Configure environment variables:
bashcp .env.example .env # Edit .env with your configuration -
Start development server:
bashnpm run dev
Development Workflow
1. Create an Issue
Before starting work, create an issue to track your contribution:
- Describe the problem or feature
- Include relevant labels
- Add to appropriate project column
- Assign to yourself if possible
2. Create a Branch
Create a feature branch from main:
bash
git checkout main
git pull origin main
git checkout -b feature/your-feature-name
Branch Naming Convention:
feature/- New featuresbugfix/- Bug fixesdocs/- Documentation changesrefactor/- Code refactoringtest/- Test additions
3. Make Changes
- Write clean, readable code
- Follow existing code style
- Add comments for complex logic
- Update documentation as needed
- Write tests for new features
4. Test Your Changes
bash
# Run tests
npm test
# Run linting
npm run lint
# Build the project
npm run build
5. Commit Your Changes
Follow commit message conventions:
text
type(scope): subject
body
footer
Types:
feat: New featurefix: Bug fixdocs: Documentation changesstyle: Code style changesrefactor: Code refactoringtest: Test changeschore: Maintenance tasks
Example:
text
feat(agent): add MCP server status indicator
Add visual indicator showing MCP server connection status
in the Agent Board. Uses green for online, red for offline.
Closes #123
6. Push and Create Pull Request
bash
git push origin feature/your-feature-name
Then create a pull request on GitHub with:
- Clear title and description
- Reference related issues
- Add appropriate labels
- Request review from maintainers
Code Style
TypeScript
- Use TypeScript for all new code
- Enable strict mode
- Use interfaces for object shapes
- Avoid
anytype - Use proper type annotations
React
- Use functional components
- Use hooks for state and effects
- Follow React best practices
- Use proper component composition
- Avoid prop drilling when possible
Electron
- Follow Electron security guidelines
- Use contextBridge for IPC
- Validate all IPC inputs
- Use preload scripts for security
- Isolate main and renderer processes
General
- Use meaningful variable names
- Keep functions small and focused
- DRY (Don't Repeat Yourself)
- Write self-documenting code
- Add comments for complex logic
Testing
Writing Tests
- Write unit tests for utilities
- Write integration tests for components
- Write E2E tests for critical paths
- Test edge cases and error conditions
- Keep tests fast and reliable
Test Structure
text
tests/
├── unit/ # Unit tests
│ ├── components/
│ └── utils/
├── integration/ # Integration tests
│ └── pages/
└── e2e/ # End-to-end tests
└── scenarios/
Running Tests
bash
# Run all tests
npm test
# Run unit tests only
npm run test:unit
# Run E2E tests
npm run test:e2e
# Run tests with coverage
npm run test:coverage
Documentation
Updating Documentation
- Update README.md for user-facing changes
- Update inline code comments
- Add API documentation for new APIs
- Update CONTRIBUTING.md for process changes
- Add examples for new features
Documentation Format
- Use Markdown for documentation
- Include code examples
- Add screenshots for UI changes
- Use clear, concise language
- Keep documentation up to date
Pull Request Guidelines
PR Description
Include in your PR description:
- Summary: Brief description of changes
- Motivation: Why this change is needed
- Changes: Detailed list of changes
- Testing: How you tested the changes
- Screenshots: For UI changes
- Related Issues: Link to related issues
PR Checklist
- Code follows project style guidelines
- Tests added/updated
- Documentation updated
- All tests passing
- No linting errors
- Commit messages follow conventions
Review Process
Getting Your PR Reviewed
- Request review from maintainers
- Address review feedback
- Make requested changes
- Update PR description if needed
- Request re-review when ready
Reviewing PRs
When reviewing PRs:
- Check code quality and style
- Verify tests are adequate
- Ensure documentation is updated
- Test the changes if possible
- Provide constructive feedback
Release Process
Versioning
Follow semantic versioning:
- MAJOR: Breaking changes
- MINOR: New features (backwards compatible)
- PATCH: Bug fixes (backwards compatible)
Changelog
Update CHANGELOG.md with:
- Version number
- Release date
- New features
- Bug fixes
- Breaking changes
- Migration guide if needed
Community Guidelines
Code of Conduct
- Be respectful and inclusive
- Welcome newcomers and help them learn
- Focus on what is best for the community
- Show empathy towards other community members
Communication
- Use GitHub Issues for bug reports
- Use GitHub Discussions for questions
- Be patient with responses
- Provide context when asking questions
- Search existing issues before creating new ones
Getting Help
Resources
- README.md - Project overview
- Architecture - System architecture
- API Documentation - API reference
- GitHub Issues - Issue tracker
Asking Questions
- Search existing issues and discussions
- Check documentation
- Create a GitHub Discussion
- Include relevant context
- Be specific about your problem
Recognition
Contributors will be recognized in:
- CONTRIBUTORS.md file
- Release notes
- Project documentation
- GitHub contributors list
Thank you for contributing to Arg0 Desktop!
Last Updated: 2026-06-29