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

Improve: Optimize the documentation of Egg Catcher project #283

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

Conversation

Gabriela20103967
Copy link

Description

For this pull request I want to solve the issue_282, improving the code, so for example in this case I separate the code into two classes one for the logic and other for the design, with separation I wanted to improve the project's maintainability, so with this will be better for future developers that want to work in the project, also I added the docstrings for the functions to have a well-documented and I updated the README file to reflect these changes.

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

Fixes #282

  • Issue_no: <282>
  • 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:Egg Catcher

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 Egg catcher project
1 participant