Contributing to CyberAi

Thank you for your interest in contributing to CyberAi! We welcome contributions from the community.

Getting Started

Prerequisites

  • Node.js 20+ and npm
  • Git
  • GitHub account
  • Basic knowledge of TypeScript and Astro (for site contributions)

Setup Development Environment

git clone https://github.com/SolanaRemix/CyberAi.git
cd CyberAi
npm install

# For site development
cd site
npm install
npm run dev

How to Contribute

Reporting Bugs

  1. Search existing issues to avoid duplicates
  2. Use the bug report template
  3. Provide clear reproduction steps
  4. Include environment details

Suggesting Features

  1. Check existing feature requests
  2. Use the feature request template
  3. Explain the use case and benefits
  4. Be open to feedback

Code Contributions

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Make your changes
  4. Write or update tests
  5. Run linters and tests: npm run lint && npm test
  6. Commit with conventional commits format
  7. Push and create a Pull Request

Code Guidelines

Code Style

  • Follow ESLint configuration
  • Use Prettier for formatting
  • Write clear, self-documenting code
  • Add comments for complex logic

Commit Messages

We use Conventional Commits:

feat: add new security audit feature
fix: resolve navigation 404 error
docs: update contributing guidelines
chore: upgrade dependencies

Testing

  • Write tests for new features
  • Update tests for bug fixes
  • Ensure all tests pass
  • Aim for good code coverage

Pull Request Process

  1. Create PR: Use the PR template
  2. Description: Explain what and why
  3. Link Issues: Reference related issues
  4. CI Checks: Ensure all checks pass
  5. Review: Respond to feedback promptly
  6. Merge: Maintainers will merge when approved

PR Checklist

  • ✅ Code follows project style guidelines
  • ✅ Tests added/updated and passing
  • ✅ Documentation updated if needed
  • ✅ No merge conflicts
  • ✅ Commits follow conventional format
  • ✅ PR description is clear and complete

Areas to Contribute

🐛 Bug Fixes

Help resolve issues and improve stability

✨ Features

Implement new capabilities and enhancements

📚 Documentation

Improve guides, examples, and API docs

🧪 Testing

Add test coverage and automation

🎨 Design

Enhance UI/UX and visual design

🔒 Security

Identify and fix vulnerabilities

Community Guidelines

Please read and follow our Code of Conduct.

Core Values

  • Be respectful and inclusive
  • Provide constructive feedback
  • Help others learn and grow
  • Focus on what's best for the project

Development Resources

Recognition

Contributors are recognized in:

  • Release notes
  • CONTRIBUTORS.md file
  • GitHub contributors page

Significant contributors may be invited to join the maintainer team.

Questions?

If you have questions about contributing: