python-mini-project icon indicating copy to clipboard operation
python-mini-project copied to clipboard

Update README.md file (Siddharth Pradeep / thirt33n / Mail-Checker Project)

Open AAdewunmi opened this issue 2 years ago • 0 comments

Description

Add README.md with detailed guidance for the project description, setup and demo output.

Fixes #(34) Project #28 does not follow repo guidance.

* Not having a specific folder for the new project.
Project #28 does not follow repo guidance. Specifically:
    Not having README.md with detailed guidance for the project description, setup and demo output.
  • [ ] Issue_no: <insert your issue no here>
  • [ ] 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)
  • [x] Documentation Update

Project

  • Your Project Name:

  • Short Description: Provide a short desctiption of your Python project

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.
  • [x] I have created a helpful and easy to understand README.md, according to the given README_TEMPLATE.
  • [x] My changes do not produce any warnings.

AAdewunmi avatar Oct 17 '22 15:10 AAdewunmi