docs: draft release notes

Author: lpm0073

CHANGELOG.md

@@ -1,3 +1,31 @@
+# Change Log
+
+## v0.2.0 Draft Release Notes
+
+- Add a config.Settings class with Pydantic validations and ability to configure at run-time via bash environment variable and/or a .env file.
+- Add SecureLoggerConfigurationError exception class to raise exception in the event of any Pydantic and/or package data validation errors during configuration.
+- add log_level input parameter to decorator to allow customization of the log level on individual log entries.
+- Refactored setup.py to remove deprecated macOS functions.
+- Add a security policy
+- Add a contributor policy
+- Added README badges to report live status of unit tests and CI/CD. Converted README to markdown.
+- Add dependabot and mergify to periodically monitor and update PyPi and NPM requirements
+- Add pre-commit with codespell, black, flake8, isort, pylint, bandit, tox, plus built-in pre-commit hooks for code style and security.
+- Added the following Github Actions:
+  - Auomated unit testing on push
+  - Auto-assign new Issues
+  - Periodic automated patch releases after Dependabot runs
+  - Pull request automation
+  - Semantic release
+  - Automated merge of main to dev branches
+- Add GitHub templates for Issue, Contributing, Funding, Pull Request
+- Add the following to the Makefile
+  - Recognition of .env file
+  - Scaffold multi platform support
+  - Make lint
+  - Make help
+
+
 ## [0.1.18](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.17...v0.1.18) (2023-12-05)
 
 

Makefile

@@ -49,9 +49,6 @@ clean:
 	rm -rf venv .pytest_cache __pycache__ .pytest_cache node_modules && \
 	rm -rf build dist secure_logger.egg-info
 
-report:
-	cloc . --exclude-ext=svg,json,zip --vcs=git
-
 test:
 	python -m unittest discover -s secure_logger/tests/ && \
 	python -m setup_test

SECURITY.md

@@ -11,7 +11,7 @@ Only the latest version of this project is currently being supported with securi
 
 ## Reporting a Vulnerability
 
-If you discover a security vulnerability within this project, please send an email to [FullStackWithLawrence@gmail.com](mailto:FullStackWithLawrence@gmail.com). All security vulnerabilities will be promptly addressed.
+If you discover a security vulnerability within this project, please send an email to [lpm0073@gmail.com](mailto:lpm0073@gmail.com). All security vulnerabilities will be promptly addressed.
 
 Please do not publicly disclose the issue until it has been addressed by the team.