FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [View Raw Code]   [Original HTTPS Page]

PythonGuide/docs/contributing.md at dependabot/pip/gitpython-3.1.30 · yoannmos/PythonGuide · GitHub

Latest commit

 

History

History
122 lines (89 loc) · 6.09 KB

File metadata and controls

122 lines (89 loc) · 6.09 KB

Dev Env Setup

Pyenv

Install pyenv with pip

  • Powershell or Git Bash: pip install pyenv-win --target $HOME\\.pyenv

  • cmd.exe: pip install pyenv-win --target %USERPROFILE%\.pyenv

Install python 3.8.10 with pyenv pyenv install 3.8.10

Set pyenv local to 3.8.10 pyenv local 3.8.10

Poetry

Install

Powershell

(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python -

osx / linux / bashonwindows

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -

Set .venv folder

poetry config virtualenvs.in-project true

Install dependencies

poetry install

Run test

In poetry you can use poetry run pytest it activate your .venv for this command

Or .\.venv\Scripts\activate then pytest

Create a new branch for starting developping

For exemple if we are in 0.1.6

Depending of what you want to implement :

Hotfix

Make a branch and Pull Request on main/master.

You will make your commit with the hotfix A a new tag 0.1.7 associated with your commit

Commit Description
1 🔖 Release version 0.1.7 Update version number in ydownloader/__init__.py and add a new tag 0.1.7 associated with your commit
2 📝 Update release notes Update docs\release_notes.md
3 🎨 Fix that bugy stuff (#15)

Feature

  • feature make a branch and Pull Request on the next feature release (ie : 0.1.x)

No-Backcompatibility

  • No-Backcompatibility make a branch and Pull Request on the next version release (ie : 0.2.x)
Commit type Emoji
Initial commit 🎉 :tada:
Version tag 🔖 :bookmark:
New feature ✨ :sparkles:
Bugfix 🐛 :bug:
Metadata 📇 :card_index:
Documentation 📚 :books:
Documenting source code 💡 :bulb:
Performance 🐎 :racehorse:
Cosmetic 💄 :lipstick:
Tests 🚨 :rotating_light:
Adding a test ✅ :white_check_mark:
Make a test pass ✔️ :heavy_check_mark:
General update ⚡ :zap:
Improve format/structure 🎨 :art:
Refactor code 🔨 :hammer:
Removing code/files 🔥 :fire:
Continuous Integration 💚 :green_heart:
Security 🔒 :lock:
Upgrading dependencies ⬆️ :arrow_up:
Downgrading dependencies ⬇️ :arrow_down:
Lint 👕 :shirt:
Translation 👽 :alien:
Text 📝 :pencil:
Critical hotfix 🚑 :ambulance:
Deploying stuff 🚀 :rocket:
Fixing on MacOS 🍎 :apple:
Fixing on Linux 🐧 :penguin:
Fixing on Windows 🏁 :checkered_flag:
Work in progress 🚧 :construction:
Adding CI build system 👷 :construction_worker:
Analytics or tracking code 📈 :chart_with_upwards_trend:
Removing a dependency ➖ :heavy_minus_sign:
Adding a dependency ➕ :heavy_plus_sign:
Docker 🐳 :whale:
Configuration files 🔧 :wrench:
Package.json in JS 📦 :package:
Merging branches 🔀 :twisted_rightwards_arrows:
Bad code / need improv. 💩 :hankey:
Reverting changes ⏪ :rewind:
Breaking changes 💥 :boom:
Code review changes 👌 :ok_hand:
Accessibility ♿ :wheelchair:
Move/rename repository 🚚 :truck:

Back | FazBrowse Home | New Git URL