Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (45 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 1.38 KB

Contributing to Keybindy

Thanks for your interest in contributing to Keybindy! 🎉
We welcome all kinds of contributions — code, documentation, bug reports, feature requests, or even ideas.

How to Contribute

1. Fork the Repository

Click the Fork button on GitHub, then clone your fork:

# Create a directory for the packages
mkdir @keybindy
cd @keybindy
# Clone your fork
git clone https://github.com/your-username/react.git 
cd react

2. Install Dependencies

# Install dependencies
bun install

3. Make Your Changes

Make your changes in a feature branch:

# Create a new branch
git checkout -b feature/your-feature-name

4. Test Your Changes

Test your changes properly with real world examples.

5. Commit & Push

Use clear commit messages:

git commit -m "feat: commit message"
git push origin feature/your-feature-name

6. Open a Pull Request

Go to your fork on GitHub and click "New pull request".
Please include a clear description and reference any related issues if possible.

Code Style

This project uses Prettier for code formatting. You can format your code using:

bun run format

Reporting Issues

If you found a bug or have a suggestion, open an issue with a clear description and reproduction steps (if applicable).

Thank you for helping make Keybindy better! ❤️