CONTRIBUTING.md

Contributing

Want to contribute to py_everything?

Do you want to contribute to this repository? Great! We love contributors! Alright, but how do you do that? You can contribute in two ways - Contribute to the Code or Contribute without the Code.

Contribute to Code

Please make commit messages helpful and useful

For basic fixes you can just fork this repository, and send it a Pull Request. You can start by fixing issues abelled good-for-new. Or you can directly start working on a new feature or fix a bug.

How to Clone? (If you know git you might skip this part)

To clone this repository, you need to have git installed.

$ git clone https://github.com/play4Tutorials/py_everything.git

And, then to go into the directory where it has been cloned, and start fixing and adding. Also, you can use the getting_started guides to start. Linked below:

For Unix Shells - getting_started.sh For Windows Shells - getting_started.bat

Prerequisites(Required)

Tools and Technologies:

1. Python <= 3.6 (<= 3.8 Preffered) - https://python.org
2. Command Prompt(Windows) or Cygwin(Windows) or Terminal(Unix-Based) or Git Bash(All OS)
3. Git
4. GitHub(Account)
5. Any web browser

Python Packages:

1. requests
2. playsound
3. setuptools
4. wheel
5. pip
6. twine (Just in case)

Optional Prerequisites

Tools and Technologies:

1. Anaconda3

Code Editor:

1. Visual Studio Code - https://code.visualstudio.com

Extensions in Visual Studio Code:

1. GitLens - Git Supercharged by Eric Amodio
2. TODO Highlight by Wayou Liu

Settings for TODO Highlight(if using):

{

    "todohighlight.keywords": [
        {
            "text": "FIX:",
            "color": "rgb(255, 0, 0)",
            "backgroundColor": "rgba(255, 0, 0, 0.2)",
        },
        {
            "text": "TIP:",
            "color": "rgb(0, 255, 0)",
            "backgroundColor": "rgba(0, 255, 0, 0.2)"
        },
        {
            "text": "TODO:",
            "color": "rgb(255, 0, 0)",
            "backgroundColor": "rgba(0, 0, 225, 0.5)"
        },
        {
            "text": "NOTE:",
            "color": "rgb()",
            "backgroundColor": "rgba()"
        }
    ]
}

Contribute Without Code

• Report potential issues, you have found, so we can fix it ASAP.
• Report issues and bug-fixes or breaking changes.
• Help us identify, vulnerable dependencies.
• Suggest new functions, and classes you want to get added in.

Things to remember

• Do not add duplicate classes or functions
• Do not create duplicate issues or features requests