Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
126 lines (90 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

126 lines (90 loc) · 3.46 KB
Raw

Contributing to AI Presentation App

Thank you for your interest in contributing to the AI Presentation App! This document provides guidelines and information for contributors.

🤝 How to Contribute

Types of Contributions

We welcome all types of contributions:

  • 🐛 Bug Reports: Found an issue? Let us know!
  • ✨ Feature Requests: Have an idea for improvement?
  • 🔧 Code Contributions: Want to add features or fix bugs?
  • 📖 Documentation: Help improve our docs
  • 🎨 Design: Suggest UI/UX improvements
  • 📚 Content: Add new slide types or improve existing content

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/ai-presentation.git
cd ai-presentation
  3. Install dependencies: 
    npm install
  4. Create a branch for your changes: 
    git checkout -b feature/your-feature-name

Development Setup

  1. Start the development server: 
    npm run dev
  2. Open the app at http://localhost:3000
  3. Make your changes and test them thoroughly

Code Style Guidelines

  • TypeScript: All new code should be written in TypeScript
  • ESLint: Follow the existing ESLint configuration
  • Tailwind CSS: Use Tailwind utility classes for styling
  • Components: Follow the existing component structure

Pull Request Process

  1. Ensure your code works and doesn't break existing functionality
  2. Update documentation if needed
  3. Add tests for new features (if applicable)
  4. Create a pull request with a clear description:
    • What changes were made
    • Why these changes are necessary
    • Any related issues
    • Screenshots (for UI changes)

Code Review Process

  • All pull requests require review before merging
  • We'll provide constructive feedback
  • Address any requested changes
  • Maintain a positive and collaborative attitude

📝 Reporting Issues

Bug Reports

When reporting bugs, please include:

  • Description: What went wrong?
  • Steps to reproduce: How can we recreate the issue?
  • Expected behavior: What should have happened?
  • Screenshots: Visual evidence if applicable
  • Environment: OS, browser, Node.js version

Feature Requests

For feature requests, please describe:

  • Problem: What issue does this solve?
  • Solution: What would you like to see?
  • Alternatives: Any alternative solutions considered?
  • Additional context: Any other relevant information

🌟 Recognition

Contributors will be recognized in:

  • The project's README
  • Release notes for significant contributions
  • GitHub contributor graphs

📞 Questions?

If you have questions about contributing:

  • Open an issue with the question label
  • Start a discussion in the repository
  • Check existing issues and discussions

🎨 Design Contributions

For design-related contributions:

  • Follow the existing design system
  • Maintain consistency with Apple/Linear-inspired aesthetics
  • Consider accessibility in all designs
  • Provide design files or mockups when possible

📱 Content Contributions

For educational content:

  • Ensure accuracy of technical information
  • Cite sources when appropriate
  • Keep explanations accessible to beginners
  • Follow the existing slide structure

Thank you for contributing to the AI Presentation App! Together, we can make AI education more accessible and engaging. 🚀