akshu-on-github / basic-programs-python Goto Github PK

Can you assign this to me for trial

Problem Description

Screenshots look messy, require refining. Steps to follow:

• Modify screenshots (base screenshots provided below)

• Replace the following code:

  ![image](https://user-images.githubusercontent.com/61582763/106519739-c508e800-6501-11eb-9133-1de5952cfe40.png)
  ![image](https://user-images.githubusercontent.com/61582763/106519960-16b17280-6502-11eb-94eb-81fd3fabfd9e.png)
  

  with the new image code. (template below:)

  <img src="new-url" alt="alt-text" width=50%>
  <img src="new-url" alt="alt-text" width=50%>
  

• Add alt and width attributes as per your discretion

Base Images

Description

The project looks rather messy as there is no naming conversion enforced. It is also difficult to locate important files such as CoC, CONTRIBUTING.md, etc. in the long list of files. Thus, there's the requirement to re-organise and rename the program files

Proposed Solution:

To combat this, I'd propose:

• #36
• #33
• #32
• [DOC] Add "Naming Convention" requirement in ./.github/ISSUE_TEMPLATE/sample-code.md
• #31
• #40

• Need to update the list of programs in the README.md file
• If possible, add links to the files themselves

Updates needed on the CONTRIBUTING.md document.

Description

There is no licence for the repo, and this reduces the score in the Community profile tab. It's strongly suggested to add a licence like MIT or Apache. Screenshot below:

Suggested Fix

• Add a licence

Topic: Instagram profile picture downloader

Reference(s) Used: instaloader Python library

Checklist:

• I have gone through the existing code samples - there are no duplicates
• I have gone through the open PRs and Issues with the sample code label - there are no duplicates
• I will create a PR to add the sample code
• I have created a PR that adds the sample code
• I have updated the index appropriately

Topic: Simple Leap Year Checker

Reference(s) Used:

Checklist:

• I have gone through the existing code samples - there are no duplicates
• I have gone through the open PRs and Issues with the sample code label - there are no duplicates
• I will create a PR to add the sample code
• I have created a PR that adds the sample code
• I have updated the index appropriately

[Edit:] Enhancements are welcome!

Summary

Move the program files (those with extension .py) into the ./Programs folder for improved organisation - remember to leave the following as is:

• README.md
• Code of Conduct
• License
• CONTRIBUTING.md
• ./.github

Summary

Add a requirement to follow these points for the names of the program files, commits and pull requests

Naming Convention:

For Program Files

• Use the .py extension
• Use lowercase
• Use hyphens to separate words
• Example:

  name-of-code-sample.py

For commits

• Same as above
• Use [CODE] prefix for the first commit. Example:

  [CODE] Add name-of-code-sample.py

• For other changes, use an imperative that describes the commit. Example:

  Add comments for clarity

For Pull Requests

• Use the first commit's message. Example:

  [CODE] Add name-of-code-sample.py

Summary

Rename the python program files as per the naming convention. Please refer to the naming convention in #31

Topic:
CSV Database

Prior to using it, ensure there is a subdirectory named "datastore" with the hosted CSV files. Amend the constants at the start of the file accordingly.

Checklist:

• I have gone through the existing code samples - there are no duplicates
• I have gone through the open PRs and Issues with the sample code label - there are no duplicates
• I will create a PR to add the sample code
• I have created a PR that adds the sample code
• I have updated the index appropriately

License to the project is missing. (Bad practice example)

• Each python program must be in a separate file
• Keep it at a beginner's level
• Please add in documentation as and when necessary

Summary

Update the list of programs in ./Programs/README.md

Points to note:

Replace

- A simple calculator using Python3
- A simple ... using Python3

with

- Calculator
- ...

Planning to use this project to explore Circle CI - first step, figure out the configuration
Reference to Configure Circle CI

Testing issues