Skip to content

alriyadsouza/Ships-On-Fire

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

Battleship Game

Welcome to the Battleship game project! This is a classic single-player strategy game where you'll be arranging your ships and attempting to sink the computer's fleet. We invite you to contribute to this open-source Python project to enhance the gameplay and bring new features to the table.

Rules of the Game

Before you start contributing, it's important to understand the rules of Battleship:

  • The game is played on two square grids, one for the player and one for the computer, typically 8x8 in size.
  • The player secretly arranges their ships on their grid. There are three ship types:
    • Battleship (3 squares)
    • Submarine (2 squares)
    • Patrol Boat (1 square)
  • The computer also arranges its ships secretly.
  • Ships must be placed without overlapping and occupy consecutive squares either horizontally or vertically.
  • The game begins with the player taking turns guessing the coordinates to target the computer's ships.
  • A successful hit results in the announcement of the sinking of that ship.

How to Contribute

To contribute to our technical documentation:

  1. Fork the Repository: Click the "Fork" button at the top right of this repository to create a copy in your GitHub account. 🍴

  2. Clone Your Fork: Clone the forked repository to your local machine using Git. 🖥️

    git clone https://github.com/yourusername/Ships-On-Fire.git
    
  3. Create a Branch: Create a new branch for your contribution under the respective folder. 🌿

    git checkout -b branch_name
    
  4. Add and Commit Your Changes: Commit your changes with a descriptive commit message. 💬

    git add file_name
    git commit -m "message"
    
  5. Push to Your Fork: Push your changes to your GitHub fork. 🚀

    git push origin branch_name
    
  6. Open a Pull Request: Submit a Pull Request (PR) to the main repository under the respective category. Include a clear title and description of your changes. 🎯

  7. Review and Merge: We will review your PR, and if it meets our guidelines, it will be merged into the documentation. 🤝

Like the Repository! ⭐️

As a first step, please consider giving our repository a ⭐️ to show your support! 🌟

Happy contributing and all the best for hacktoberfest! 💻