diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..463de054 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,23 @@ +# Description + + + +## Type of issue + +- [ ] Feature (New Script) +- [ ] Bug +- [ ] Documentation + +## Checklist: + +- [ ] I have read the project guidelines. +- [ ] I have checked previous issues to avoid duplicates. +- [ ] This issue will be meaningful for the project. + + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..2798e6b6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,37 @@ +# Description + +A short summary of what is included in your Pull Request. + +Fixes #(issue_no) + + +- [ ] Issue_no: `````` +- [ ] 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 + + +- #### **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. +- [ ] I have created a helpful and easy to understand `README.md`, according to the given [`README_TEMPLATE.`](https://github.com/nduongthucanh/python-mini-project/blob/master/README_TEMPLATE.md) +- [ ] My changes do not produce any warnings. diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml deleted file mode 100644 index e559e1cb..00000000 --- a/.github/workflows/python-app.yml +++ /dev/null @@ -1,36 +0,0 @@ -# This workflow will install Python dependencies, run tests and lint with a single version of Python -# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions - -name: Python application - -on: - push: - branches: [ main ] - pull_request: - branches: [ main ] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: Set up Python 3.9 - uses: actions/setup-python@v2 - with: - python-version: 3.9 - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install flake8 pytest - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - - name: Lint with flake8 - run: | - # stop the build if there are Python syntax errors or undefined names - flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics - # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - - name: Test with pytest - run: | - pytest diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml deleted file mode 100644 index efccd595..00000000 --- a/.github/workflows/python-package.yml +++ /dev/null @@ -1,40 +0,0 @@ -# This workflow will install Python dependencies, run tests and lint with a variety of Python versions -# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions - -name: Python package - -on: - push: - branches: [ main ] - pull_request: - branches: [ main ] - -jobs: - build: - - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - python-version: [3.7, 3.8, 3.9] - - steps: - - uses: actions/checkout@v2 - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 - with: - python-version: ${{ matrix.python-version }} - - name: Install dependencies - run: | - python -m pip install --upgrade pip - python -m pip install flake8 pytest - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - - name: Lint with flake8 - run: | - # stop the build if there are Python syntax errors or undefined names - flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics - # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - - name: Test with pytest - run: | - pytest diff --git a/IMG/main.gif b/IMG/main.gif new file mode 100644 index 00000000..8ec7015a Binary files /dev/null and b/IMG/main.gif differ diff --git a/README.md b/README.md index 33b4162c..f57e0585 100644 --- a/README.md +++ b/README.md @@ -5,36 +5,70 @@ [![forthebadge](https://forthebadge.com/images/badges/powered-by-coffee.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com) -[![forthebadge](https://forthebadge.com/images/badges/built-with-swag.svg)](https://forthebadge.com) +[![forthebadge](https://forthebadge.com/images/badges/powered-by-black-magic.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/made-with-python.svg)](https://forthebadge.com) -# Python Mini Projects +# Python Mini Projects -![Issues](https://img.shields.io/github/issues/nduongthucanh/python-mini-project) -![Pull Requests](https://img.shields.io/github/issues-pr/nduongthucanh/python-mini-project) -![Forks](https://img.shields.io/github/forks/nduongthucanh/python-mini-project) -![Stars](https://img.shields.io/github/stars/nduongthucanh/python-mini-project) + > A collection of easy Python small projects to help you improve your programming skills. - A collection of easy Python small projects to help you improve your programming skills. +![Issues](https://img.shields.io/github/issues/nduongthucanh/python-mini-project?style=social&logo=github) +![Pull Requests](https://img.shields.io/github/issues-pr/nduongthucanh/python-mini-project?style=social&logo=github) +![Forks](https://img.shields.io/github/forks/nduongthucanh/python-mini-project?style=social&logo=github) +![Stars](https://img.shields.io/github/stars/nduongthucanh/python-mini-project?style=social&logo=github) +[![License](https://img.shields.io/github/license/nduongthucanh/python-mini-project?style=social&logo=github)](https://github.com/nduongthucanh/python-mini-project/blob/main/LICENSE) -## 📜 **Steps to follow** + +## Table Of Contents + - [ Aim Of The Project](#xml-version10-encodingutf-8svg-width24-height24-viewbox0-0-48-48-fillnone-xmlnshttpwwww3org2000svgrect-width48-height48-fillwhite-fill-opacity001circle-cx24-cy24-r20-stroke9013fe-stroke-width4-stroke-linecapround-stroke-linejoinroundpath-fill-ruleevenodd-clip-ruleevenodd-dm24-37v44v37z-fill50e3c2path-dm24-37v44-stroke9013fe-stroke-width4-stroke-linecapround-stroke-linejoinroundpath-fill-ruleevenodd-clip-ruleevenodd-dm36-24h44h36z-fill50e3c2path-dm36-24h44-stroke9013fe-stroke-width4-stroke-linecapround-stroke-linejoinroundpath-fill-ruleevenodd-clip-ruleevenodd-dm4-24h11h4z-fill50e3c2path-dm4-24h11-stroke9013fe-stroke-width4-stroke-linecapround-stroke-linejoinroundpath-fill-ruleevenodd-clip-ruleevenodd-dm24-11v4v11z-fill50e3c2path-dm24-11v4-stroke9013fe-stroke-width4-stroke-linecapround-stroke-linejoinroundsvg-aim-of-the-project) + - [ Contributing](#xml-version10-encodingutf-8svg-width24-height24-viewbox0-0-48-48-fillnone-xmlnshttpwwww3org2000svgrect-width48-height48-fillwhite-fill-opacity001rect-x28-y28-width16-height16-fill50e3c2-stroke9013fe-stroke-width4-stroke-linejoinroundpath-dm13-4l22-20h4l13-4z-fill50e3c2-stroke9013fe-stroke-width4-stroke-linejoinroundpath-dm36-20c404183-20-44-164183-44-12c44-758172-404183-4-36-4c315817-4-28-758172-28-12c28-164183-315817-20-36-20z-fill50e3c2-stroke9013fe-stroke-width4-stroke-linejoinroundpath-dm4-28l20-44-stroke9013fe-stroke-width4-stroke-linecapround-stroke-linejoinroundpath-dm20-28l4-44-stroke9013fe-stroke-width4-stroke-linecapround-stroke-linejoinroundsvg-contributing) + - [ README Template for scripts](#xml-version10-encodingutf-8svg-width24-height24-viewbox0-0-48-48-fillnone-xmlnshttpwwww3org2000svgrect-width48-height48-fillwhite-fill-opacity001path-dm10-44c889543-44-8-431046-8-42v6c8-489543-889543-4-10-4h38c391046-4-40-489543-40-6v42c40-431046-391046-44-38-44h10z-fill50e3c2-stroke9013fe-stroke-width4-stroke-linejoinroundpath-fill-ruleevenodd-clip-ruleevenodd-dm21-22v4h33v22l27-157273l21-22z-fill9013fe-strokefff-stroke-width4-stroke-linecapround-stroke-linejoinroundpath-dm10-4h38-stroke9013fe-stroke-width4-stroke-linecapround-stroke-linejoinroundsvg-readme-template-for-scripts) + - [ Projects](#xml-version10-encodingutf-8svg-width24-height24-viewbox0-0-48-48-fillnone-xmlnshttpwwww3org2000svgrect-width48-height48-fillwhite-fill-opacity001path-dm15-8c892487-8-4-129249-4-19c4-30-17-40-24-423262c31-40-44-30-44-19c44-129249-390751-8-33-8c292797-8-259907-98469-24-126738c220093-98469-187203-8-15-8z-fill50e3c2-stroke9013fe-stroke-width4-stroke-linecapround-stroke-linejoinroundsvg-projects) + - [ Feedback](#xml-version10-encodingutf-8svg-width24-height24-viewbox0-0-48-48-fillnone-xmlnshttpwwww3org2000svgpath-dm2137-36c2282-3075-2789-27-3373-2762c3929-2821-4371-329-4399-3848c4406-3995-4386-4136-4343-4267c4317-4347-4239-44-4154-44h117584c671004-44-292371-393814-391377-344311l999994-4h219999l259999-11l1743-1713l149999-14-fill50e3c2path-dm2137-36c2282-3075-2789-27-3373-2762c3929-2821-4371-329-4399-3848c4406-3995-4386-4136-4343-4267c4317-4347-4239-44-4154-44h117584c671004-44-292371-393814-391377-344311l999994-4h219999l259999-11l1743-1713l149999-14-stroke9013fe-stroke-width4-stroke-miterlimit2-stroke-linecapround-stroke-linejoinroundpath-dm174395-1713l219995-34-stroke9013fe-stroke-width4-stroke-miterlimit2-stroke-linecapround-stroke-linejoinroundsvg-feedback) -### 1. 🌟 Star The Repo + +## Aim Of The Project + +As a Python newbie, I understand the problems that people face when they first begin studying and attempting to understand various Data Science concepts, particularly Python. This project is designed for folks who are just getting started with Python principles and exploring GitHub as "contributors." + +My goal is to build a common playground where everyone, from beginners to experts, can learn and share knowledge, and I hope you enjoy your stay here! + +Let's "folk-ing" create amazing things together! 👉 + + +## Contributing + +
+ +Step 1: Star The Repo + Star the repo by pressing the topmost-right button to start your wonderful journey +![star repo](https://docs.github.com/assets/images/help/stars/starring-a-repository.png) + +
+ --- -### 2. 🍴 **Fork it** +
+ +Step 2: Fork it + On the [GitHub page for this repository](https://github.com/nduongthucanh/python-mini-project), click on the Button "**Fork**". ![fork image](https://help.github.com/assets/images/help/repository/fork_button.jpg) +
+ --- -### 3. 👥 **Clone it** +
+ +Step 3: Clone it + * **Method 1:** GitHub Desktop @@ -46,7 +80,7 @@ Learn more about how to clone the remote respository on your local machine using * **Method 2:** Git -To create clone ***your forked repository*** on your local machine, run this command inside your terminal: +Clone the forked repository. Open git bash and type: ```bash git clone https://github.com//python-mini-project.git @@ -58,67 +92,53 @@ git clone https://github.com//python-mini-project.git Learn more about [forking](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [cloning a repo](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository). ---- - -### 4. ⬆️ Set it up -* **Method 1:** GitHub Desktop - -Learn more about how to clone the remote respository on your local machine using **GitHub Desktop** [here](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop#cloning-a-repository). - -* **Method 2:** Git - -Run the following commands to see that *your local copy* has a reference to *your forked remote repository* in Github :octocat: - -```sh -$ git remote -v -origin https://github.com/Your_Username/python-mini-project.git (fetch) -origin https://github.com/Your_Username/python-mini-project.git (push) -``` - -Now, let's add a reference to the original [Python mini project](https://github.com/nduongthucanh/python-mini-project/) repository using - -```sh -$ git remote add upstream https://github.com/srimani-programmer/Breast-Cancer-Predictor.git -``` - -> This adds a new remote named ***upstream***. +
--- -### 5. ♻️ Sync it +
+ +Step 4: Create your feature branch + Always keep your local copy of the repository updated with the original repository. Before making any changes and/or in an appropriate interval, follow the following steps: * **Method 1:** GitHub Desktop +Learn more about how to creat new branch [here](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches#creating-a-branch) and how to fetch and pull origin from/to your local machine [here](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch). + Learn more about how to fetch and pull origin from/to your local machine using **GitHub Desktop** [here](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch). + + * **Method 2:** Git Run the following commands ***carefully*** to update your local repository ```sh -# Fetch all remote repositories and delete any deleted remote branches -$ git fetch --all --prune - -# Switch to `New_Pipeline` branch -$ git checkout New_Pipeline +# If you cloned a while ago, get the latest changes from upstream +git checkout +git pull upstream -# Reset local `main` branch to match the `upstream` repository's `main` branch -$ git reset --hard upstream/main +# Make a feature branch (Always check your current branch is up to date before creating a new branch from it to avoid merge conflicts) +git checkout -b -# Push changes to your forked `Breast-Cancer-Predictor` repo -$ git push -u origin New_Pipeline +# ``` ---- +
-### 6. 🐇 Ready, Set, Go... +--- +
+ +Step 6: Ready, Set, Go... + Once you have completed these steps, you are ready to start contributing to the project and creating **pull requests**. - Create a folder in - [projects directory](https://github.com/nduongthucanh/python-mini-project) according to issue name. + [projects directory](https://github.com/nduongthucanh/python-mini-project) according to your project name. +> The folder name should follow the following format "Your_Project_Name_Here". For example: Dice_Stimulator - Write your code and add to the respective folder in the projects directory, locally. - Don't forget to add a `README.md` in your folder, according to the [README_TEMPLATE.](https://github.com/Python-World/python-mini-projects/blob/master/README_TEMPLATE.md) @@ -141,7 +161,14 @@ Push the code *to your repository*. ```bash git push origin ``` -### 7. 🐢 Pull Request +
+ +--- + +
+ +Step 7: Pull Request + Go to the GitHub page of _your fork_, and **make a pull request**: @@ -151,14 +178,32 @@ Read more about pull requests on the [GitHub help pages](https://help.github.com Now wait, until *your Pull Request* is approved! If there are any conflicts, you will get a notification. -## README Template for scripts +
+ +
+ +## README Template for scripts + +please make sure to add a `README.md` file that follow the same construction as this template for consistency. [README Template](https://github.com/nduongthucanh/python-mini-project/blob/master/README_TEMPLATE.md) -## Projects ✨ +## Projects SR No | Project | Author --- | --- | --- 1 | [Dice Rolling Stimulator](https://github.com/nduongthucanh/python-mini-project/tree/main/Dice_Rolling_Stimulator) | [Leah Nguyen](https://github.com/nduongthucanh) 2 | [Dictionary](https://github.com/nduongthucanh/python-mini-project/tree/main/Dictionary)| [Leah Nguyen](https://github.com/nduongthucanh) 3 | [Hangman Game](https://github.com/nduongthucanh/python-mini-project/tree/main/Hangman_Game) | [Leah Nguyen](https://github.com/nduongthucanh) + +## Feedback + +If you have any feedback or ideas to improve this project, feel free to contact me via + + + Reeha's Linkdein + + + + Reeha's Github + \ No newline at end of file