Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 2.24 KB

CONTRIBUTING.rst

File metadata and controls

57 lines (44 loc) · 2.24 KB
Raw

Contributing

Thanks for considering contributing to Cardroom! Your contributions are greatly appreciated, and help make Cardroom a better tool for everyone in the computer engineering community.

Setting up Your Development Environment

  1. Fork the Cardroom repository on GitHub.
  2. Clone your fork locally: git clone git@github.com:uoftcprg/cardroom.git
  3. Setup virtual environment: python -m venv venv
  4. Activate the virtual environment: source venv/bin/activate
  5. Install requirements: pip install -r requirements.txt
  6. Create a branch for your changes: git checkout -b branch-name

Making Changes

When making changes, please follow these guidelines:

  • Always write your code in compliance with PEP8.
  • Write unit tests for your changes, and make sure all tests pass before submitting a pull request.
  • Document your changes in the code and update the README file if necessary.
  • After making changes, please validate your changes.
  1. Run style checking: flake8 cardroom
  2. Run static type checking: mypy cardroom
  3. Run checks for missing docstrings: interrogate -f 100 -i -m -n -p -s -r '^\w+TestCase' cardroom
  4. Run unit tests: DJANGO_SETTINGS_MODULE=settings python -m cardroom test
  5. Run doctests: python -m doctest cardroom/*.py

Submitting a Pull Request

  1. Commit your changes: git commit -am 'Add some feature'
  2. Push to the branch: git push origin branch-name
  3. Submit a pull request to the main branch in the Cardroom repository.

Before submitting your pull request, please make sure the mypy static type checking, flake8, unit tests pass, and your code adheres to PEP8.

After Your Pull Request Is Merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main repository:

  • Delete the remote branch on GitHub: git push origin --delete branch-name
  • Check out the main branch: git checkout main
  • Delete the local branch: git branch -d branch-name
  • Update your main with the latest upstream version: git pull upstream main