A template repository that I start my git repos from with common boilerplate things already added. Anyone is welcome to use this template.
A short description of what this project does.
If you enjoy this project, consider giving it a GitHub star ⭐ to show your support.
A short description of why this project exists. What use-case is it meant to solve?
List the features of this project:
- Feature 1
- Feature 2
A quick guide on how to get started with this project. Install a NuGet Package? A link to download the latest version from (releases page, PowerShell Gallery, etc)? Code snippets? Links to wiki or other documentation.
Issues and Pull Requests are welcome. See the Contributing page for more details.
See what's changed in the application over time by viewing the changelog.
Buy me a [CANADIAN ITEM] for providing this [EXTENSION|APP|SCRIPT] open source and for free 🙂
FOR A GENERIC DONATE LINK USE THIS BUTTON
FOR AN APP SPECIFIC DONATE LINK GO HERE AND CREATE A NEW BUTTON, THEN REPLACE THE BUTTON_ID_GOES_HERE
WITH THE NEW BUTTON'S ID
While anyone is free to use this template, some of the content is specific to my personal information and how I like to structure my projects, so that information should be updated or removed.
Files containing Dan's personal information that should be updated:
- License: Update to match your project's license, and ensure it uses the correct name in the copyright.
- CODEOWNERS: Update to match your project's maintainers, or remove this file.
- FUNDING: Update to match your project's donation information, or remove this file.
- ReadMe: Update with your project's information, and remove the Donate section or update it to not use Dan's links.
Other boilerplate git repository files that should be reviewed and updated or removed as needed:
- Changelog: If you don't plan to track a changelog, remove this file and it's reference from the ReadMe.
- Contributing: Update to match your project's contributing guidelines and complete the sections that need more information, or remove it.
- Architectural Decision Records: Remove this directory if you don't plan to use ADRs, and it's reference from the Contributing page.
- bug_report, feature_request, pull_request_template: Update the bug report, feature request, and pull request templates as needed to meet your requirements, or remove them.