61 lines (42 loc) · 1.55 KB

Contributing Guidelines

Thank you for your interest in contributing! 🎉
We welcome contributions of all kinds — bug reports, features, refactors, and documentation.

Please read this guide carefully before submitting issues or pull requests.

How to Contribute

1. Reporting Bugs

Search existing issues before opening a new one
Use the Bug Report issue form
Provide clear reproduction steps

2. Suggesting Features

Open a Feature Request issue
Clearly explain the motivation and use case
Be open to feedback and discussion

3. Submitting Pull Requests

Fork the repository
Create a feature branch from the latest main
Keep changes focused and minimal
Use the appropriate PR template:
- new_feature.md
- bug_fix.md
- refactor.md

Branch Naming Convention

Examples:

feature/user-notifications
bugfix/login-validation
refactor/api-layer

Testing Requirements

All new features must include tests where applicable
Bug fixes should include regression coverage
Refactors must not break existing tests

Code Style & Quality

Follow existing code style and patterns
Avoid unnecessary dependencies
Keep functions small and readable
Comment complex logic where necessary

Pull Request Review Process

All PRs require review before merging
Maintainers may request changes
Be respectful and responsive to feedback

Code of Conduct

By participating, you agree to follow the project's Code of Conduct.

Thank you for helping make this project better 🚀