Thank you for considering contributing to Simple BlackJack Game! This document provides guidelines and instructions for contributing to the project.
- Fork the repository
- Clone your fork:
git clone https://github.com/CTechDigitalpt/simple-blackjack-game.git - Install dependencies:
pip install -r requirements.txt(if available) - Create a branch for your feature or bugfix:
git checkout -b feature/your-feature-name
- Follow PEP 8 style guidelines for Python code
- Use descriptive variable and function names
- Add comments for complex logic
- Keep functions small and focused on a single task
- Write docstrings for classes and functions
- Add appropriate tests for your changes
- Make sure all existing tests pass before submitting a pull request
- Run tests using:
python -m unittest discover(or the project's testing method)
- Update your branch with the latest changes from main:
git pull origin main - Resolve any conflicts
- Make sure your code passes all tests
- Submit a pull request with a clear description of the changes
- Link any related issues in your pull request description
When reporting issues, please include:
- A clear description of the problem
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Screenshots if applicable
- System information (OS, Python version, etc.)
- Be respectful and inclusive
- Provide constructive feedback
- Help maintain a positive and collaborative environment
Thank you for contributing to make Simple BlackJack Game better!