Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (49 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

57 lines (49 loc) · 1.64 KB

Contributing to GPTDARR

Thank you for your interest in contributing to GPTDARR! This guide will help you get started with contributing to our project.

Ways to Contribute

There are several ways you can contribute to GPTDARR:

  • 🐛 Bug reports and feature requests
  • 💻 Code contributions
  • 📚 Documentation improvements
  • 🔍 Code reviews
  • 🧪 Test improvements

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Install dependencies: 
    pnpm install
  4. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  5. Make your changes and commit them: 
    git commit -m "feat: your feature description"
  6. Push to your fork: 
    git push origin feature/your-feature-name
  7. Open a Pull Request

Development Guidelines

  • Follow the existing code style
  • Write clear, descriptive commit messages
  • Include tests for new features
  • Update documentation as needed
  • Keep PRs focused and manageable

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Update the documentation if you're changing functionality
  3. The PR will be reviewed by maintainers
  4. Address any feedback and make requested changes
  5. Once approved, your PR will be merged

Code Style

  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused and single-purpose
  • Follow JavaScript/TypeScript best practices

Questions?

Feel free to open an issue for any questions or concerns. We're here to help!

Thank you for contributing to GPTDARR! Your contributions help make this tool better for everyone.