update and add TODO notes

Author: eleanorjboyd

src/features/creators/templates/newPackageTemplate/.gitignore

@@ -31,3 +31,5 @@ MANIFEST
 
 
 .pytest_cache/
+
+# TODO: add other files and folders to ignore if needed

src/features/creators/templates/newPackageTemplate/.vscode/settings.json

@@ -1,7 +1,5 @@
 {
-    "python.testing.pytestArgs": [
-        "tests"
-    ],
+    "python.testing.pytestArgs": ["tests"],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true
 }

src/features/creators/templates/newPackageTemplate/README.md

@@ -0,0 +1,36 @@
+# Project Name
+
+> TODO: Write a short description of your project and what it does.
+
+## Table of Contents
+
+- [Project Name](#project-name)
+  - [Table of Contents](#table-of-contents)
+  - [How to Run](#how-to-run)
+  - [How to Package](#how-to-package)
+  - [How to Test](#how-to-test)
+  - [Setup for New Contributors](#setup-for-new-contributors)
+  - [License](#license)
+
+## How to Run
+
+> TODO: Describe how to use or run your package, with example commands or code.
+
+
+## How to Package
+
+> TODO: Explain how to build and distribute the package (e.g., using setuptools, poetry, etc.).
+
+
+## How to Test
+Tests are stored in the `tests` folder. Tests can be run using pytest with the following command:
+`<run_exec> pytest`
+
+## Setup for New Contributors
+
+> TODO: List steps for a new developer to get started.
+1. 
+
+## License
+
+> TODO: State your license (e.g., MIT, Apache 2.0).

src/features/creators/templates/newPackageTemplate/dev-requirements.txt

@@ -1,3 +1,4 @@
 pytest
 setuptools
-wheel
+wheel
+# TODO: update the necessary requirements to develop this package

src/features/creators/templates/newPackageTemplate/package_name/__main__.py

@@ -1,3 +1,6 @@
+# TODO: Update the main function to your needs or remove it.
+
+
 def main() -> None:
     print("Start coding in Python today!")
 

src/features/creators/templates/newPackageTemplate/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
-name = "Package Template"
+name = "package_name"
 version = "1.0.0"
-description = "A Python package template."
+description = TODO: Add a short description of your package
 readme = "README.md"
 
 requires-python = ">=3.8"

src/features/creators/templates/newPackageTemplate/tests/test_package_name.py

@@ -0,0 +1 @@
+# TODO: Write tests for your package using pytest