ArkAung / tictactoe

Simple Tic Tac Toe app written in Python

Tic Tac Toe

A simple Tic Tac Toe game built with Python and Tkinter. This repo is meant to demonstrate how to structure a typical project such as: project directory structure, unit tests, instructive README to run, test and build, Makefile to facilitate running, building and testing the project, project depedency management and CI workflow.

Table of Contents

• Getting Started
• Running the Application
• Building the Application
• Running Tests
• Contributing
• License

Getting Started

To get started with this project, you should have Python 3.7 or higher and Poetry installed on your machine.

1. Clone the repository:

git clone https://github.com/<username>/tictactoe.git
cd tictactoe

2. Install the project dependencies using Poetry:

poetry install

Running the Application

To run the Tic Tac Toe game, you can use the run Makefile target:

make run

Alternatively, you can run the game directly using Python:

poetry run python -m tictactoe.tictactoe

Building the Application

To build the Tic Tac Toe game into a standalone binary, you can use the build Makefile target:

make build

This will generate a standalone binary in the dist directory.

Running Tests

To run the unit tests for the Tic Tac Toe game, you can use the test Makefile target:

make test

Alternatively, you can run the tests directly using Python:

poetry run python -m unittest discover tests

Contributing

We welcome contributions from the community. To contribute to this project, please follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository:

git clone https://github.com/<your-username>/tictactoe.git
cd tictactoe

3. Create a new branch for your changes:

git checkout -b feature/<your-feature-name>

4. Make your changes and commit them using Conventional Commits format:

git add .
git commit -m "<type>(<scope>): <description>"

5. Push your branch to your forked repository:

git push -u origin feature/<your-feature-name>

6. Create a pull request (PR) to merge your branch into the main branch. Please ensure that your commit messages follow the Conventional Commits specification to ensure that the project conforms to semantic versioning.

License

This project is licensed under the MIT License - see the LICENSE file for details.