Contributing

We welcome contributions from the community! Here's how you can help make EthixAI better.

Ways to Contribute

🐛 Report Bugs

Found a bug? Help us fix it by submitting a detailed issue.

Report Bug

💡 Feature Requests

Have an idea for a new feature? We'd love to hear it!

Request Feature

📝 Documentation

Improve or add to our documentation and tutorials.

View Docs

💻 Code Contributions

Submit pull requests for bug fixes or new features.

View PRs

Development Setup

Get your local development environment ready.

1. Fork and Clone

# Fork the repo on GitHub first, then:
git clone https://github.com/YOUR_USERNAME/EthAI-Guard.git
cd EthAI-Guard
git remote add upstream https://github.com/GeoAziz/EthAI-Guard.git

2. Create a Branch

git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

3. Install Dependencies

# Frontend
cd frontend && npm install

# Backend
cd backend && pip install -r requirements.txt

# AI Core
cd ai_core && pip install -r requirements.txt

4. Run Tests

# Frontend tests
npm test

# Backend tests
pytest

# Ensure all tests pass before submitting PR

Code Standards

TypeScript/React

• Use TypeScript for all new files
• Follow ESLint configuration
• Use functional components with hooks
• Add JSDoc comments for public APIs
• Write unit tests for components

Python

• Follow PEP 8 style guide
• Use type hints for functions
• Write docstrings for all modules
• Format with Black (line length 100)
• Add unit tests with pytest

Pull Request Process

1
Update your branch
Sync with upstream/main before submitting
2
Write clear commit messages
Use conventional commits format (feat:, fix:, docs:)
3
Add tests
Include unit tests for new features or bug fixes
4
Update documentation
Document new features in appropriate docs pages
5
Submit PR
Use the PR template and link related issues
6
Address review feedback
Respond to code review comments promptly

Code of Conduct

We are committed to providing a welcoming and inclusive environment for all contributors.

✓

Be respectful and considerate in all interactions

✓

Welcome newcomers and help them get started

✓

Focus on constructive feedback and solutions

✗

No harassment, discrimination, or offensive behavior

✗

No trolling, spam, or deliberate disruption

Report violations to conduct@ethixai.com

Recognition

We value all contributions and recognize our contributors in the following ways:

• Listed in CONTRIBUTORS.md file
• Mentioned in release notes for significant contributions
• Special recognition badges for sustained contributors
• Opportunities to join the core team

Ready to Contribute?

Join our community and help build the future of ethical AI.

View on GitHub Join Discord