Contributing

Contribute to Comet AI

We're building the future of AI-powered browsing, and we need your help! Whether you're a developer, designer, writer, or user, there's a way to contribute.

1.2k

GitHub Stars

150+

Pull Requests

50+

Contributors

500+

Discord Members

Get Involved

How to Contribute

Bug Reports

Help us identify and fix issues

Search existing issues before creating new ones
Include version number and platform
Provide steps to reproduce
Attach relevant logs and screenshots

Feature Requests

Suggest new features and improvements

Describe the use case and problem
Suggest how the feature should work
Consider backward compatibility
Discuss with maintainers first

Code Contributions

Submit pull requests to the codebase

Fork the repository
Create a feature branch
Follow code style guidelines
Add tests for new features

Documentation

Improve docs and examples

Fix typos and clarify unclear sections
Add examples and tutorials
Translate to other languages
Update outdated information

For Developers

Development Setup

Fork the Repository

Create your own copy of the project on GitHub

gh repo fork Preet3627/Comet-AI

Clone Your Fork

Download the code to your local machine

git clone https://github.com/YOUR_USERNAME/Comet-AI.git

Install Dependencies

Install all required packages for development

cd comet-browser && npm install

Start Development Server

Run the app in development mode

npm run dev

Project Structure

comet-browser/

Electron desktop application with AI integration

• main.js - Main process
• preload.js - Preload scripts
• src/components/ - React UI
• src/lib/ - Core services
• src/service/ - Background services

flutter_browser_app/

Flutter mobile app for desktop control

• lib/main.dart - App entry
• lib/pages/ - UI screens
• lib/sync_service.dart - WiFi sync
• lib/pages/ - Desktop control

Landing_Page/

Marketing website and documentation

• src/app/docs/ - Documentation
• src/components/ - UI components
• src/lib/firebase.ts - Auth

Standards

Code Style

JavaScript/TypeScript

Use 2 spaces for indentation
Prefer const over let
Use async/await over raw promises
Follow existing naming conventions
Add JSDoc comments for public APIs

React Components

Use functional components with hooks
Keep components under 300 lines
Extract custom hooks for logic
Use named exports for utilities
Colocate styles with components

Commit Messages

Use imperative mood (add, fix, update)
Keep subject line under 50 chars
Reference issues with #number
Explain 'why' not 'what'
Use conventional commits format

Before Submitting

PR Checklist

Before Opening a Pull Request

Ensure your changes meet these requirements

My code follows the project's style guidelines

I have performed a self-review of my code

I have commented complex parts of my code

My changes generate no new warnings or errors

I have added tests that prove my fix/feature works

I have updated documentation where necessary

My PR targets the correct branch (main for fixes)

I have linked the related issue in my PR description

Important Note

Large pull requests may take longer to review. Consider breaking large changes into smaller, focused PRs. This makes review easier and allows for faster merging.

Responsible Disclosure

Security Issues

Found a Security Vulnerability?

Please report it responsibly via our security channel

What to Report

• Detailed description of the vulnerability
• Steps to reproduce the issue
• Potential impact assessment
• Suggested remediation (if any)

What We Promise

• Acknowledge within 48 hours
• Keep you updated on progress
• Credit in security advisories
• Fair recognition for valid reports

Report Security Issue

Join Our Community

Connect with other contributors, get help, and shape the future of Comet AI.

GitHub Documentation