Contributing

Jump to bottom

Greeniac edited this page Nov 22, 2025 · 1 revision

Contributing to FairMind

Welcome! We're excited that you're interested in contributing to FairMind. This guide will help you get started.

Quick Start

Find a Good First Issue
- Check our Good First Issues page
- Look for issues labeled good first issue
- Read the issue description carefully
Set Up Your Environment
- See Development Setup
- Clone the repository
- Install dependencies
- Run the development server
Make Your Contribution
- Create a branch for your work
- Make your changes
- Write tests if applicable
- Submit a pull request

Finding Issues

Good First Issues

Perfect for newcomers! These issues are:

Well-documented
Have clear acceptance criteria
Include getting started instructions
Low complexity, high impact

View Good First Issues →

By Category

Frontend: React/Next.js, UI/UX improvements
Backend: API, database, services
AI/ML: Model development, bias detection
Testing: E2E tests, unit tests
Documentation: Guides, tutorials

By Milestone

Development Workflow

Fork the Repository
Create a Branch: git checkout -b feature/your-feature-name
Make Changes: Follow code style guidelines
Test Your Changes: Run tests and verify functionality
Commit: Write clear commit messages
Push: Push to your fork
Pull Request: Create a PR with description

Code Style

Follow existing code patterns
Use TypeScript for type safety
Write meaningful commit messages
Add comments for complex logic
Update documentation as needed

Getting Help

Issues: Ask questions in issue comments
Discussions: Use GitHub Discussions for general questions
Documentation: Check our docs folder

Recognition

Contributors are recognized in:

Repository contributors list
Release notes
Project documentation

Thank you for contributing to FairMind!