Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
95 lines (70 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

95 lines (70 loc) · 2.54 KB

Contributing to Agentokratia

Thank you for your interest in contributing to Agentokratia! This document provides guidelines and instructions for contributing.

Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.

How to Contribute

Reporting Bugs

Before submitting a bug report:

  1. Check existing issues to avoid duplicates
  2. Use the bug report template when creating a new issue
  3. Include steps to reproduce, expected behavior, and actual behavior
  4. Add screenshots if applicable

Suggesting Features

  1. Check existing issues and discussions first
  2. Use the feature request template
  3. Clearly describe the use case and proposed solution

Pull Requests

  1. Fork the repository
  2. Create a feature branch from main: 
    git checkout -b feature/your-feature-name
  3. Make your changes following our coding standards
  4. Write or update tests if applicable
  5. Run linting, formatting, and type checking: 
    npm run lint
npm run format
npm run type-check
  6. Commit with conventional commit messages (pre-commit hooks will lint and format)
  7. Push and open a pull request

Commit Messages

We use Conventional Commits. Commits are validated by commitlint.

Format: type: description

Types:

Type Description
feat New feature
fix Bug fix
docs Documentation only
style Formatting, no code change
refactor Code change without fix or feature
perf Performance improvement
test Adding tests
chore Maintenance
ci CI/CD changes
build Build system changes
revert Revert previous commit

Examples:

  • feat: add user profile page
  • fix: resolve wallet connection issue on mobile
  • docs: update README with new setup instructions
  • refactor: simplify authentication flow

Coding Standards

  • Use TypeScript for all new code
  • Follow existing code style and patterns
  • Use meaningful variable and function names
  • Keep components small and focused
  • Add comments for complex logic

Development Setup

  1. Fork and clone the repository
  2. Install dependencies: npm install
  3. Copy .env.example to .env.local and configure
  4. Start development server: npm run dev

Testing

  • Test your changes locally before submitting
  • Ensure the build passes: npm run build
  • Verify type checking: npm run type-check

Questions?

Open a discussion or reach out to the maintainers.