Skip to content

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 ๐Ÿš€

  1. Fork the repository
  2. Create a new branch for your feature/fix: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Write or update tests as needed
  5. Run the test suite
  6. Commit your changes using conventional commit messages:
  7. feat: add new feature
  8. fix: resolve bug issue
  9. docs: update documentation
  10. test: add tests
  11. refactor: improve code structure
  12. Push to your fork
  13. 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.