Contributing to HyperLimit

Thank you for your interest in contributing to HyperLimit! This document provides guidelines and instructions for contributing.

Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.

How to Contribute

Fork the Repository
- Fork the repository to your GitHub account
- Clone your fork locally
Create a Branch
- Create a branch for your changes
- Use a clear and descriptive branch name (e.g., feature/add-xxx-support or fix/memory-leak)
Make Your Changes
- Write clear, commented code
- Follow the existing code style and formatting
- Add tests for new features
- Update documentation as needed
Test Your Changes
- Run the existing test suite: npm test
- Ensure all tests pass
- Add new tests for new functionality
Commit Your Changes
- Use clear and meaningful commit messages
- Keep commits focused and atomic
- Reference any relevant issues in commit messages
Submit a Pull Request
- Push your changes to your fork
- Submit a pull request to the main repository
- Provide a clear description of your changes
- Link any related issues

Development Setup

Install dependencies:
```
npm install
```
Build the project:
```
npm run build
```
Run tests:
```
npm test
```

Pull Request Guidelines

Update documentation for any changed functionality
Add tests for new features
Keep pull requests focused on a single change
Follow the project's coding style
Make sure all tests pass
Update the changelog if applicable

Reporting Issues

Use the GitHub issue tracker
Check if the issue already exists
Provide a clear and descriptive title
Include steps to reproduce the issue
Include relevant system information

Getting Help

If you need help with your contribution:

Check the documentation
Search existing issues and discussions
Create a new discussion if needed

License

By contributing to HyperLimit, you agree that your contributions will be licensed under the project's license.