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

Python Development Project Readme Template #9

Open
pratyush-giri opened this issue Oct 1, 2022 · 0 comments
Open

Python Development Project Readme Template #9

pratyush-giri opened this issue Oct 1, 2022 · 0 comments

Comments

@pratyush-giri
Copy link
Collaborator

Readme Creation👷

Create a README.md file in your folder, example Peter_Solutions/README.md and add the required packages to be installed before running the program.
Below are the points that are to be properly mentioned in your readme.

1. Project Explanation with Title🚀

Describe the explanation in your words with a proper title of the project, which can be too precise and short.

2. Problem Solving🤯

  • Try to mention your project plans and implementation.
  • Be precise and try to maintain the required factors.

3. Mention the Tech - Stack 👨‍💻👩‍💻

Be precise and be as clear as possible with your tech - stack

Project submission

based on the level and complicacy of the projects ,you are advised to add your project folder for eg:- YOUR_NAME/xyz.py to the
to the respective projects_Intermediate/PYTHON_DEVELOPEMENT or projects_Advanced/PYTHON_DEVELOPEMENT .
Your folder should contain following information:-

  • The requirements.txt file
  • The .gitignore file
  • The python src file

The deciding factors for the level of your projects solely depends upon the technical stacks used in it. Below are some level
specific projects similar to which your projects will be considered or else will be rejected .

Intermediate level example

  • TIC TAC TOE GAME
  • ROCK PAPER SCISSORS
  • GUI CALCULATOR

Advanced level example

  • CHATBOT
  • FACE MASK DETECTION

Suggestion if any 📝

Tell us what better can be implemented

If new can refer to the following instructions and start contribution Contribution Guide 🤝

@Aditya-150 Aditya-150 changed the title Python Development Project submission guidelines Python Development Project Readme Template Oct 1, 2022
@Aditya-150 Aditya-150 added the readme template Template for README.md file label Oct 1, 2022
@Aditya-150 Aditya-150 pinned this issue Oct 1, 2022
@KingFire25 KingFire25 mentioned this issue Oct 4, 2022
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants