Contributing Guide

Thank you for considering contributing to the AI Store project!

Getting Started

Prerequisites

• Node.js 18+
• npm or yarn
• Git
• Code editor (VS Code recommended)

Setup

1. Fork the repository

   # Fork on GitHub, then clone
   git clone https://github.com/your-username/Server-December-AIStore.git
   cd Server-December-AIStore
   

2. Install dependencies

   npm install
   

3. Create a branch

   git checkout -b feature/your-feature-name
   

4. Start development server

   npm run dev
   

Development Workflow

Code Style

• Follow TypeScript best practices
• Use ESLint configuration
• Format code with Prettier
• Follow existing code patterns

File Structure

• Components in components/
• Hooks in hooks/
• Utilities in lib/
• Types in types/
• Pages in app/

Naming Conventions

• Components: PascalCase (MyComponent.tsx)
• Hooks: camelCase with use prefix (useMyHook.ts)
• Utilities: camelCase (myUtility.ts)
• Types: PascalCase (MyType.ts)

Making Changes

Before You Start

1. Check existing issues
2. Discuss major changes in issues
3. Create an issue for new features
4. Ensure tests pass

During Development

1. Write clean code

   • Clear variable names
   • Add comments for complex logic
   • Follow DRY principle

2. Add tests

   • Unit tests for utilities
   • Component tests for UI
   • Integration tests for flows

3. Update documentation

   • Update relevant docs
   • Add code examples
   • Update API docs if needed

Commit Messages

Follow conventional commits:

feat: add new feature
fix: fix bug
docs: update documentation
style: formatting changes
refactor: code refactoring
test: add tests
chore: maintenance tasks

Examples:

• feat: add dark mode toggle
• fix: resolve modal closing issue
• docs: update API documentation

Pull Request Process

Before Submitting

1. Update code

   git add .
   git commit -m "feat: your feature"
   git push origin feature/your-feature-name
   

2. Run tests

   npm test
   

3. Check linting

   npm run lint
   

4. Build check

   npm run build
   

PR Checklist

• [ ] Code follows style guidelines
• [ ] Tests pass
• [ ] Documentation updated
• [ ] No console errors
• [ ] Build succeeds
• [ ] Commit messages follow conventions

PR Description

Include:

• What changes were made
• Why changes were made
• How to test
• Screenshots (if UI changes)
• Related issues

Code Review

Review Process

1. Maintainers review PRs
2. Address feedback
3. Make requested changes
4. PR approved and merged

Review Criteria

• Code quality
• Test coverage
• Documentation
• Performance impact
• Security considerations

Testing

Running Tests

# All tests
npm test

# Watch mode
npm test:watch

# Coverage
npm test:coverage

Writing Tests

import { render, screen } from '@testing-library/react';
import MyComponent from './MyComponent';

describe('MyComponent', () => {
  it('renders correctly', () => {
    render(<MyComponent />);
    expect(screen.getByText('Hello')).toBeInTheDocument();
  });
});

Documentation

Updating Docs

1. API Documentation (docs/API.md)

   • Add new APIs
   • Update examples
   • Fix errors

2. Component Docs (docs/COMPONENTS.md)

   • Document new components
   • Update props tables
   • Add examples

3. Guides (docs/GUIDES.md)

   • Add new guides
   • Update existing guides
   • Add troubleshooting

Bug Reports

Reporting Bugs

Include:

• Description of bug
• Steps to reproduce
• Expected behavior
• Actual behavior
• Environment details
• Screenshots (if applicable)

Bug Report Template

## Bug Description
Brief description of the bug

## Steps to Reproduce
1. Step one
2. Step two
3. Step three

## Expected Behavior
What should happen

## Actual Behavior
What actually happens

## Environment
- OS: [e.g., macOS 13.0]
- Browser: [e.g., Chrome 120]
- Node: [e.g., 18.17.0]

## Screenshots
If applicable

Feature Requests

Requesting Features

Include:

• Feature description
• Use case
• Proposed solution
• Alternatives considered

Feature Request Template

## Feature Description
Brief description of the feature

## Use Case
Why is this feature needed?

## Proposed Solution
How should it work?

## Alternatives
Other solutions considered

Code of Conduct

Our Standards

• Be respectful
• Be inclusive
• Be constructive
• Be professional

Unacceptable Behavior

• Harassment
• Discrimination
• Trolling
• Personal attacks

Getting Help

Resources

• Documentation: /docs
• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Support: Contact maintainers

Questions

• Check documentation first
• Search existing issues
• Ask in discussions
• Create an issue if needed

Recognition

Contributors will be:

• Listed in CONTRIBUTORS.md
• Mentioned in release notes
• Credited in documentation

License

By contributing, you agree that your contributions will be licensed under the same license as the project.

Thank You!

Thank you for contributing to the AI Store project! Your contributions make this project better for everyone.