Skip to content

Commit df7bf93

Browse files
authored
Add QoL changes (#14)
## Describe your changes Update syntax and address grammatical errors.
1 parent d8aa7e2 commit df7bf93

File tree

3 files changed

+18
-15
lines changed

3 files changed

+18
-15
lines changed

.github/pull_request_template.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
<!--- Please write your PR name in the present imperative tense. Examples of that tense are: "Fix issue in the dispatcher where…", "Improve our handling of…", etc." -->
2-
<!-- For more information on Pull Requests, you can reference here: https://success.vanillaforums.com/kb/articles/228-using-pull-requests-to-contribute -->
1+
<!---
2+
Please write your PR name in the present imperative tense. Examples of that tense are:
3+
"Fix issue in the dispatcher where…", "Improve our handling of…", etc."
4+
5+
For more information on Pull Requests, you can reference here:
6+
https://success.vanillaforums.com/kb/articles/228-using-pull-requests-to-contribute
7+
-->
38
## Describe your changes
49

510

@@ -10,6 +15,6 @@
1015
<!--- These are suggested things you could add, but what you add will be dependent on your repository's standards. --->
1116
- [ ] The code runs successfully.
1217

13-
```console
18+
```commandline
1419
HERE IS SOME COMMAND LINE OUTPUT
1520
```

Makefile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
# https://www.gnu.org/software/make/manual/html_node/Introduction.html
33
default: create-requirements lint
44

5-
BASEDIR=project
6-
75
.PHONY: lint
86
lint:
97
pre-commit run --all-files

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Poetry Python 🐍 Project Template
2-
This repository is a template for a python 🐍 project using the poetry container. The intent is to do all the basic lifting for a python project so that people can hit the ground running with their ideas.
2+
This repository is a template for a python 🐍 project using the poetry container. The intent is to do all the basic
3+
lifting for a python project so that people can hit the ground running with their ideas.
34

45
### To make this project your own
56
1. Create a new repository, [using this one as a template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
67
2. Change the `project` folder name to the kebab-case name of your project.
7-
3. Update the `BASE_DIR` variable value in the `Makefile` with the kebab-case name of your project.
8-
4. Update the information in the `pyproject.toml` file with your project's and your personal information.
9-
5. Update the information in the `CODEOWNERS` file so that it uses your GitHub ID and the kebab-case name of your project folder.
8+
3. Update the information in the `pyproject.toml` file with your project's and your personal information.
9+
4. Update the information in the `CODEOWNERS` file so that it uses your GitHub ID and the kebab-case name of your project folder.
1010

1111
### 🐍 by Default (Feel free to delete this after creating your project)
12-
- [pre-commit]([https://github.com/psf/black](https://pre-commit.com/)): This serves as the codebase formatter and linter.
13-
- [Requests](https://requests.readthedocs.io/en/latest/): This is the project's means of communicating with external APIs.
14-
- [Responses](https://github.com/getsentry/responses): This is used in conjunction with Pytest and Requests to mock API calls in the test module.
12+
- [pre-commit](https://pre-commit.com/): This serves as the codebase formatter and linter.
13+
- [requests](https://requests.readthedocs.io/en/latest/): This is the project's means of communicating with external APIs.
14+
- [responses](https://github.com/getsentry/responses): This is used in conjunction with Pytest and Requests to mock API calls in the test module.
1515

1616
### Project Requirements
1717
- Python version: `^3.11`
@@ -26,6 +26,6 @@ This repository is a template for a python 🐍 project using the poetry contain
2626
- Example: `poetry add black`
2727

2828
## Standard Commands
29-
- `make lint`: Runs `pre-commit`
30-
- `make test`: Runs test cases in the `test` directory
31-
- `make run`: Runs the `main` function in the `project` folder
29+
- `make lint`: Runs `pre-commit`.
30+
- `make test`: Runs test cases in the `test` directory.
31+
- `make run`: Runs the `main` function in the `project` folder.

0 commit comments

Comments
 (0)