Contributing Guidelines ๐ค
Thank you for your interest in contributing to Bazario! This document outlines the guidelines for contributing to this project.
Code of Conduct ๐
By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.
How to Contribute ๐ฏ
Reporting Issues ๐
- Before creating an issue, please check if a similar issue already exists
- Use the issue template when creating new issues
- Provide as much detail as possible, including:
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Error messages
- Environment details
Pull Requests ๐
- Fork the repository
- Create a new branch for your feature/fix:
git checkout -b feature/your-feature-name
- Make your changes
- Write or update tests as needed
- Run the test suite
- Commit your changes using conventional commit messages:
feat: add new feature
fix: resolve bug issue
docs: update documentation
test: add tests
refactor: improve code structure
- Push to your fork
- Create a Pull Request
Code Style โจ
- Follow PEP 8 guidelines
- Use type hints
- Write docstrings for functions and classes
- Keep functions and methods focused and concise
- Use meaningful variable and function names
Testing ๐งช
- Write unit tests for new features
- Ensure all tests pass before submitting PR
- Maintain or improve code coverage
Documentation ๐
- Update documentation for new features
- Include docstrings for public APIs
- Update README.md if necessary
- Keep documentation clear and concise
License โ๏ธ
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.