Merge pull request #1 from deniscep/denisceplinting-fixes

Deniscep linting fixes

Author: deniscep

README.md

@@ -1,29 +1,20 @@
-Python repository sample on how to build and layer your monorepo. 
-This is a cookiecutter reusable template and the steps bellow explain how to reuse this repository.
+# Cookiecutter Python repository demonstrating how to construct and layer your monorepo
 
-## Cookiecutter - create template for Python repository
+This is a lightweight, reusable Python Cookiecutter template, containing main folder structure you would need for any Python project.
 
-1. In your project, in order to create templates, rename all your files/folders with the keyword 'cookiecutter' followed by the item name
-    example: folder        -> {{cookiecutter.documents}}
-             python file   -> {{cookiecutter.main}}.py
-2. Add cookiecutter.json at the root of your project where you define the templates you created
-3. Push the folder structure to your repo (Github, Azure Devops)
+Project contains a basic Python folder structure, Architecture Decision Record & documentation structure, pull request template, as well as CI/CD pipeline with super-linter.
 
-## Cookiecutter - reuse template from Github (windows)
+## Quickstart
 
-1. On your local create a new folder where you will store the repository you want to clone.
-2. Make sure your terminal is pointing to your new folder.
-3. Create a virtual environment: python -m venv environment
-4. Activate environment: .\environment\Scripts\activate
-5. Install cookiecutter lib for pyton: pip install cookiecutter
-6. Clone repo with cookiecutter: cookiecutter https://github.com/youruser/CookiecutterRepo.git (your github clone url)
+Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):
 
-## Other tips
+```pip install -U cookiecutter```
 
-1. When using step #6 from above, yout repo will be cloned in the .cookiecutter folder
-2. For working with a specific branch you can just copy its content in the .cookiecutter folder and use that version for testing
+Generate a Python package project:
 
-## Documentation
+```https://github.com/microsoft/cookiecutter_template_for_python```
+
+## Cookiecutter Documentation
 
 - [cookiecutter-library](https://pypi.org/project/cookiecutter-python/)
 - [cookie-cutter-documentation](https://cookiecutter.readthedocs.io/en/stable/)
@@ -44,8 +35,8 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
 
 ## Trademarks
 
-This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
-trademarks or logos is subject to and must follow 
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
+trademarks or logos is subject to and must follow
 [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
 Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
 Any use of third-party trademarks or logos are subject to those third-party's policies.

SECURITY.md

@@ -1,6 +1,6 @@
 <!-- BEGIN MICROSOFT SECURITY.MD V0.0.8 BLOCK -->
 
-## Security
+# Security
 
 Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
 
@@ -14,17 +14,17 @@ Instead, please report them to the Microsoft Security Response Center (MSRC) at
 
 If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey).
 
-You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). 
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc).
 
 Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
 
-  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
-  * Full paths of source file(s) related to the manifestation of the issue
-  * The location of the affected source code (tag/branch/commit or direct URL)
-  * Any special configuration required to reproduce the issue
-  * Step-by-step instructions to reproduce the issue
-  * Proof-of-concept or exploit code (if possible)
-  * Impact of the issue, including how an attacker might exploit the issue
+* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+* Full paths of source file(s) related to the manifestation of the issue
+* The location of the affected source code (tag/branch/commit or direct URL)
+* Any special configuration required to reproduce the issue
+* Step-by-step instructions to reproduce the issue
+* Proof-of-concept or exploit code (if possible)
+* Impact of the issue, including how an attacker might exploit the issue
 
 This information will help us triage your report more quickly.
 

cookiecutter.json

@@ -1,8 +1,6 @@
 {
   "project_name": "Your Project Name",
-  "docs": "documents folder",
   "infra": "infrastructure as code",
-  "libs": "3rd party libraries",
   "python_project": "your python project name",
   "_copy_without_render": [
     "*.html",

{{cookiecutter.project_name}}/.github/pull_request_template.md

@@ -1,3 +1,5 @@
+# PR Name
+
 Please give a proper description of your PR:
 
 - This PR is about adding this feature

{{cookiecutter.project_name}}/README.md

@@ -1,18 +1,22 @@
-## Project
-This is a python repository sample on how to build and layer your monorepo.
-This example uses Github Actions and Terraform.
+# Project
+
+This repository provides a sample of how to construct and organize a Python monorepo.
+The sample utilizes Github Actions and Terraform.
 
 ## Structure example description
+
     .
-    ├── .github               # Github Action folders that enables for CI and CD for your repo
+    ├── .github               # Github Action folders for CI and CD for your repo
     │   ├── actions           # Add custom actions
     │   ├── scripts           # Add custom scripts
     │   ├── workflows         # Build your Github Actions by adding a workflow file
     ├── documents             # Documentation about the project
     │   ├── design            # Add your designs and architectures here
+    │       ├── assets        # Holds binary content like 'jpg', 'png', 'css', etc.
     │   ├── spikes            # Holds code samples for investigation
     │   ├── adr               # ADR (Architecture Decision Record)
-    ├── assets                # Holds content like 'jpg', 'img', 'css', 'fonts's
+    │       ├── assets        # Holds binary content like 'jpg', 'png', 'css', etc.
+    ├── assets                # Holds binary content like 'jpg', 'png', 'css', etc.
     ├── infrastructure        # Holds your infrastructure as code, in our case Terraform
     │   ├── terraform         # Holds all terraform files
     │   ├── variables         # Holds all terraform variables
@@ -21,10 +25,9 @@ This example uses Github Actions and Terraform.
     │   ├── python-solution
     ├── README.md
 
-## CI pipeline 
-This is an initial sample of a CI pipeline for our repository. The pipeline uses super-linter which is a combination of linters, in order to validate the entire source code.
-This means that python, yaml, .md and tf files will be validated all together, based on current configuration
-Code secrets scan to ensure no sensitive information or credentials are being committed.
+## CI pipeline
+
+This is a base sample of a continuous integration (CI) pipeline for the repository. The pipeline uses super-linter, a fusion of multiple linters, to validate the entire source code, including Python, YAML, .md, and TF files, as specified in the current configuration. It also performs a code secrets scan to verify that no confidential information or credentials are being committed.
 
 ## Template for pull request
 
@@ -35,4 +38,4 @@ In the .github folder there is a pull_request_template.md which contains an exam
 - [super-linter](https://github.com/github/super-linter)
 - [github-actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions)
 - [monorepo](https://www.atlassian.com/git/tutorials/monorepos)
-- [terrafrom](https://developer.hashicorp.com/terraform/intro)
+- [terrafrom](https://developer.hashicorp.com/terraform/intro)

{{cookiecutter.project_name}}/docs/adr/0001-record-architecture-decisions.md

@@ -0,0 +1,28 @@
+# 0001 - Record architecture decisions
+
+Date: 2023-01-01
+
+## Status
+
+Accepted
+
+## Context
+
+We need to record the architectural decisions made on this project
+
+## Decision drivers
+
+Recording decisions will help us keep track of what choices have been made and why.
+
+## Considered options
+
+- not recording decisions
+- recording decisions outside of repository
+
+## Decision
+
+We will use Architecture Decision Records, as described by Michael Nygard in the article [Documenting Architecture Decisions](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions)
+
+## Consequences
+
+See Michael Nygard's article, linked above. For a lightweight markdown template, see this [Gist](https://gist.github.com/christoferlof/215664f3cc938a72fa498600bfdb0a8a)