Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (38 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

54 lines (38 loc) · 1.46 KB
Raw

Contributing to GitCraft AI Studio

Thank you for your interest in contributing to GitCraft AI Studio! We welcome contributions from the community.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/gitcraft-ai-studio.git
  3. Create a feature branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Commit your changes: git commit -m "Add your feature"
  6. Push to your fork: git push origin feature/your-feature-name
  7. Create a Pull Request

Development Setup

Please refer to the README.md for detailed setup instructions.

Code Style

  • Use TypeScript for all new code
  • Follow the existing code style
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Write tests for new features

Commit Messages

We follow conventional commit format:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code style changes (formatting, etc)
  • refactor: Code refactoring
  • test: Adding or updating tests
  • chore: Maintenance tasks

Pull Request Process

  1. Ensure all tests pass
  2. Update documentation if needed
  3. Add a clear description of your changes
  4. Reference any related issues

Reporting Issues

  • Use the issue tracker to report bugs
  • Provide detailed information about the issue
  • Include steps to reproduce if applicable

License

By contributing, you agree that your contributions will be licensed under the MIT License.