Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance the Dice Rolling project #281

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

Gabriela20103967
Copy link

Description

This pull request I want to enhance the dice stimulator refactoring the code into a class and add docstrings to it, so the code will be easy to understand, additionally, I incorporate a new feature which this new feature the players can roll the dice again without restarting the terminal, the players can now also exit the game at any time. And I update the README file with these changes.

image

Key Changes:

  1. Refactored code into a class:
  • The functionality of the dice stimulator has been encapsulated within the 'DiceSimulator' class.
  • This restructuring improves code readability, maintainability, and reusability.
  1. Added Docstrings:
  • Comprehensive docstrings have been added to the class and its methods to provide clear documentation on their purpose and usage.
  1. New feature- Play Again Option:
  • Players can now choose to roll the dice again without restarting the program.
  • An option to exit the game has been added, enhancing the user experience.
  1. Update README:
  • The README file has been updated to reflect these changes.
  • Added instructions on how to run the game, game instructions, and details about the new features and class structure.

A short summary of what is included in your Pull Request.

Fixes #279

  • Issue_no: <279>
  • Not applicable

Type of change

Choosing one or more options from the following as per the nature of your Pull request.

  • New project insert
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation Update

Project

  • Project Name: Dice Rolling Stimulator

Checklist:

Please tick all the boxes that are fulfilled by your Pull Request.

  • I have named my files and folder, according to this project's guidelines.
  • My code follows the style guidelines of this project.
  • I have commented on my code, particularly in hard-to-understand areas.
  • I have created a helpful and easy to understand README.md, according to the given README_TEMPLATE.
  • My changes do not produce any warnings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

enhance the Dice Rolling Stimulator
1 participant