Skip to content

Latest commit

 

History

History
92 lines (64 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

92 lines (64 loc) · 2.97 KB
Raw

Contributing to LLMBox

First off, thank you for considering contributing to LLMBox! It's people like you that make LLMBox such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to [email protected].

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if possible

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Follow the style guides
  • Include screenshots and animated GIFs in your pull request whenever possible

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Style Guide

  • Use eslint and prettier with the provided configuration
  • Use modern JavaScript features when possible
  • Comment your code when necessary
  • Follow the existing code style

React Style Guide

  • Use functional components with hooks
  • Keep components small and focused
  • Use PropTypes for type checking
  • Follow the project's existing component structure

CSS/Tailwind Style Guide

  • Follow the existing class naming convention
  • Use Tailwind's utility classes when possible
  • Avoid custom CSS unless absolutely necessary
  • Keep responsive design in mind

Getting Started

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Development Process

  1. Pick an issue to work on or create a new one
  2. Discuss the implementation in the issue
  3. Fork the repository and create a branch
  4. Implement your changes
  5. Write or update tests if necessary
  6. Update documentation
  7. Submit a pull request

Testing

  • Write tests for new features
  • Ensure all tests pass before submitting a pull request
  • Follow the existing testing patterns

Thank you for contributing! 🎉