Skip to content

Contributing to RequireKit

Guidelines for contributing to RequireKit.

Ways to Contribute

  • Report bugs or issues
  • Suggest new features
  • Improve documentation
  • Submit pull requests
  • Share examples

Getting Started

  1. Fork the repository
  2. Clone your fork
  3. Create a branch for your changes
  4. Make changes and test
  5. Submit pull request

Development Guidelines

Code Style

  • Follow existing patterns
  • Write clear commit messages
  • Add tests for new features
  • Update documentation

Documentation

  • Use clear, concise language
  • Include examples
  • Update relevant guides
  • Check for broken links

Testing

  • Test all changes locally
  • Verify examples work
  • Check cross-references

Pull Request Process

  1. Describe your changes clearly
  2. Reference related issues
  3. Include tests if applicable
  4. Update documentation
  5. Wait for review

Questions?

  • Open an issue for discussion
  • Check existing issues first
  • Be respectful and constructive

For questions, open an issue on GitHub.