Skip to content

Latest commit

Β 

History

History
50 lines (39 loc) Β· 1.2 KB

File metadata and controls

50 lines (39 loc) Β· 1.2 KB

Contributing

Thanks for your interest in contributing! πŸ’»πŸ
Whether you're fixing bugs, writing tests, or improving documentation, all contributions are welcome.

πŸ› οΈ Getting Started

  1. Fork this repository
  2. Clone your fork:
    git clone https://github.com/your-username/project-name.git
    cd project-name
  3. Create a new branch:
    git checkout -b feature/your-feature-name

βœ… Development Guidelines

  • Follow PEP8 coding style.
  • We use Ruff to ensure code quality:
    ruff check
  • Tests are written using unittest. To run all tests:
    python3 -m unittest discover -s tests
  • Add or update tests when fixing bugs or adding features.

πŸ“ Commit Messages

Use clear and concise commit messages:

git commit -m "Fix: correct issue with user authentication"

πŸš€ Submitting a Pull Request

  1. Push your changes:
    git push origin feature/your-feature-name
  2. Open a pull request on the original repository
  3. Describe your changes clearly

🐞 Reporting Issues

If you find bugs or have suggestions, open an issue with as much detail as possible.