README.md

Home

This example repository showcases many best practices, patterns, and tools to ease developer burden.

Example Repository Template features

The following patterns, practices, and tools are used as part of this repository template.

• Containerized Tools
• Conventional Commits
• Markdown Architectural Decision Records
• MKDocs
• MarkdownLint
• Open Source & InnerSource Best Practices
• Pre-commit Framework
• SemVer support
• VSCode Support

How to use this repository

You will need a working python environment and docker in place to use all the features of this repository.

1. Install requirements
   • Python
   • Docker
2. Clone this repository
3. Delete the .git folder
4. Make any changes that you may want!

Intentionally Left Out

• Signed commits - In this reference repo, I did not feel the need to require signed commits mostly due to the learning curve. For any downstream use of this project, I would highly recommend using signed commits.