Thank you for your interest in contributing! This document outlines the process and guidelines for contributing.
- Fork the repository
- Create a new branch for your feature/fix (
git checkout -b feature/my-feature) - Make your changes
- Commit your changes (
git commit -am 'Add new feature') - Push to the branch (
git push origin feature/my-feature) - Create a Pull Request
- Provide a clear description of the changes
- Include any relevant issue numbers
- Ensure all tests pass
- Follow the existing code style
- Update documentation if needed
- Follow consistent indentation (spaces/tabs as per project standard)
- Use meaningful variable and function names
- Add comments for complex logic
- Keep functions focused and concise
When reporting issues, please include:
- A clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Your environment details
- Any relevant screenshots or error messages
- Clone the repository
- Install dependencies
- Follow setup instructions in README.md
- Make sure all tests pass before making changes
- Be respectful and inclusive
- Use welcoming language
- Accept constructive criticism
- Focus on what's best for the community
If you have questions, feel free to open an issue for discussion.
Thank you for contributing!