From 2350ea04051abf70f90e923d099255dda89c8049 Mon Sep 17 00:00:00 2001 From: David Slusser Date: Mon, 19 Feb 2024 16:47:39 -0800 Subject: [PATCH] adding pr template --- .github/PULL_REQUEST_TEMPLATE.md | 21 +++++++++++++++++++ .github/STYLE_GUIDE.md | 36 ++++++++++++++++++++++++++++++-- 2 files changed, 55 insertions(+), 2 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e7dbfa9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +## Pull Request + +### Description: +Provide a brief description of the changes introduced by this pull request + +### Related Issue(s): +Add links to applicable Github issues +- #1 +- #2 + +### Checklist: +- [ ] All code quality checks pass +- [ ] Code follows the project's style guide +- [ ] Documentation has been updated + + +### Testing: +- [ ] Existing tests provided necessary coverage +- [ ] Applicable tests have been updated +- [ ] Applicable tests have been added +- [ ] This change does not require testing diff --git a/.github/STYLE_GUIDE.md b/.github/STYLE_GUIDE.md index 69f1cb5..da261d8 100644 --- a/.github/STYLE_GUIDE.md +++ b/.github/STYLE_GUIDE.md @@ -9,6 +9,7 @@ and readability of the code. - [Naming Conventions](#naming-conventions) - [Docstrings](#docstrings) - [Typing](#typing) +- [Virtual Environments](#virtual-environments)
@@ -222,7 +223,7 @@ Python's optional type hints, introduced in PEP 484 and expanded in subsequent P ```python # Consistent style with `:` - def greet(name: str) -> None: + def greet(name: str): print(f"Hello, {name}!") # Consistent style with `->` @@ -309,4 +310,35 @@ Python's optional type hints, introduced in PEP 484 and expanded in subsequent P return func(a, b) ``` -
\ No newline at end of file +
+ +## Virtual Environments + +### Introduction + +A virtual environment is a self-contained directory that contains a Python interpreter and allows you to install and manage project-specific dependencies. Use a virtual environment to isolate project dependencies and avoid conflicts with system-wide packages. + + +### Creating a Virtual Environment +To create a virtual environment, use the following command at the **root** of the repository: + +```shell +python -m venv venv +``` + +### Activating the Virtual Environment +Once the virtual environment is created, activate it using the appropriate command for your operating system: + +For Windows: + +```shell +venv\Scripts\activate +``` + +For Mac, Linux, and WSL: + +```shell +source venv/bin/activate +``` + +