Skip to content

Commit

Permalink
adding pr template
Browse files Browse the repository at this point in the history
  • Loading branch information
davidslusser committed Feb 20, 2024
1 parent 070ddfa commit 2350ea0
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 2 deletions.
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
36 changes: 34 additions & 2 deletions .github/STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and readability of the code.
- [Naming Conventions](#naming-conventions)
- [Docstrings](#docstrings)
- [Typing](#typing)
- [Virtual Environments](#virtual-environments)

<br/>

Expand Down Expand Up @@ -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 `->`
Expand Down Expand Up @@ -309,4 +310,35 @@ Python's optional type hints, introduced in PEP 484 and expanded in subsequent P
return func(a, b)
```

<br/>
<br/>

## 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
```

<br/>

0 comments on commit 2350ea0

Please sign in to comment.