From c14565a455dcf5b1e6dd6265d94f1b7c2ee8fcd2 Mon Sep 17 00:00:00 2001 From: Tim O'Guin Date: Sun, 14 Mar 2021 00:28:48 -0600 Subject: [PATCH] Initial commit --- .github/CODEOWNERS | 1 + .github/CODE_OF_CONDUCT.md | 131 ++++ .github/CONTRIBUTING.md | 38 + .github/ISSUE_TEMPLATE/.keep | 0 .github/PULL_REQUEST_TEMPLATE/.keep | 0 .github/SECURITY.md | 12 + .github/workflows/.keep | 0 .gitignore | 1103 +++++++++++++++++++++++++++ CHANGELOG.md | 37 + LICENSE | 21 + README.md | 89 +++ 11 files changed, 1432 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/.keep create mode 100644 .github/PULL_REQUEST_TEMPLATE/.keep create mode 100644 .github/SECURITY.md create mode 100644 .github/workflows/.keep create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..097c812 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @timoguin diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c2bb3d8 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,131 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at timoguin@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..ce22b99 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make +via issue, email, or any other method with the owners of this repository before +submitting a change. + +## Issue Tracking + +Issues can be tracked via [GitHub Issues]. + +## Pull Request Process + +We encourage a fork-based workflow, where experimental branches will live in your fork +until they're ready to be submitted upstream via a PR. + +1. Fork this repository. +2. Create a new branch of off master for your work. +3. Update the [README] to document your change. See [Readme Driven Development] (or + RDD!) for more information about this workflow. +4. Update or add a breaking test for your change. +5. Add your change until the tests pass. +6. Add a note about your change to the _[Unreleased]_ section of the [CHANGELOG]. +7. Squash or rebase your commits. +8. Create a PR back to the master branch of this repo. +9. The repo [CODEOWNERS] will be tagged for PR review. +10. Once your change is approved, your PR will be merged. +11. When maintainers create a new release, your [CHANGELOG] entry will be moved + from the _[Unreleased]_ section to the section for the new version. +12. You've done it! + + + +[GitHub Issues]: https://github.com/timoguin/repo-template/issues). +[README]: README.md +[Readme Driven Development]: https://tom.preston-werner.com/2010/08/23/readme-driven-development.html +[CHANGELOG]: CHANGELOG.md +[Unreleased]: CHANGELOG.md#Unreleased +[CODEOWNERS]: .github/CODEOWNERS diff --git a/.github/ISSUE_TEMPLATE/.keep b/.github/ISSUE_TEMPLATE/.keep new file mode 100644 index 0000000..e69de29 diff --git a/.github/PULL_REQUEST_TEMPLATE/.keep b/.github/PULL_REQUEST_TEMPLATE/.keep new file mode 100644 index 0000000..e69de29 diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..12f7727 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,12 @@ +# Reporting Security Issues + +For issues related to security within this project, please [open an issue] describing +the problem, and it will be addressed. If it is something you think may be sensitive, +you may contact the maintainers via email. + +Maintainers: + +- Tim O'Guin + + +[open an issue]: https://github.com/timoguin/repo-template/issues diff --git a/.github/workflows/.keep b/.github/workflows/.keep new file mode 100644 index 0000000..e69de29 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5a1992f --- /dev/null +++ b/.gitignore @@ -0,0 +1,1103 @@ +# ===================================================================================== +# +# This is a large gitignore file that includes many common ignore patterns for various +# languages, tooling, and operatings systems. It is mostly limited to things I have +# used. +# +# Trim it down to fit your needs. Please note that there are some patterns that are +# intentionally duplicated across different sections. That way you won't lose a +# necessary pattern when you remove a section you don't need. +# +# Most of these patterns are taken from GitHub's collection of gitignore files, with +# slight modifications for my own preferences: https://github.com/github/gitignore +# +# Common patterns for the following languages are included: +# +# - Clojure +# - Erlang +# - Golang +# - Haskell +# - Lua +# - NodeJS +# - Python +# - Rust +# +# Patterns for the following tools are included: +# +# - JetBrain's IDEs +# - Packer +# - Terraform +# - Vim +# - Visual Studio +# - Visual Studio Code +# +# And, finally, patterns for common OS files are included: +# +# - Linux +# - MacOS +# - Windows +# +# ===================================================================================== + + +####################################################################################### +# Languages +####################################################################################### + +# ------------------------------------------------------------------------------------- +# Clojure +# ------------------------------------------------------------------------------------- + +pom.xml +pom.xml.asc +*.jar +*.class +/lib/ +/classes/ +/target/ +/checkouts/ +.lein-deps-sum +.lein-repl-history +.lein-plugins/ +.lein-failures +.nrepl-port +.cpcache/ + +# ------------------------------------------------------------------------------------- +# Erlang +# ------------------------------------------------------------------------------------- + +.eunit +*.o +*.beam +*.plt +erl_crash.dump +.concrete/DEV_MODE + +# rebar 2.x +.rebar +rel/example_project +ebin/*.beam +deps + +# rebar 3 +.rebar3 +_build/ +_checkouts/ + +# ------------------------------------------------------------------------------------- +# Golang +# ------------------------------------------------------------------------------------- + +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Directories commonly used for storing built binaries +bin/ +dist/ + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories +# Many projects commit the vendored dependencies to the repo. While it adds a lot +# of extra code, it also guarantees some extra safety. +# +# Remove the comment below to include it. +# vendor/ + +# ------------------------------------------------------------------------------------- +# Haskell +# ------------------------------------------------------------------------------------- + +dist +dist-* +cabal-dev +*.o +*.hi +*.hie +*.chi +*.chs.h +*.dyn_o +*.dyn_hi +.hpc +.hsenv +.cabal-sandbox/ +cabal.sandbox.config +*.prof +*.aux +*.hp +*.eventlog +.stack-work/ +cabal.project.local +cabal.project.local~ +.HTF/ +.ghc.environment.* + +# ------------------------------------------------------------------------------------- +# Lua +# ------------------------------------------------------------------------------------- + +# Compiled Lua sources +luac.out + +# luarocks build files +*.src.rock +*.zip +*.tar.gz + +# Object files +*.o +*.os +*.ko +*.obj +*.elf + +# Precompiled Headers +*.gch +*.pch + +# Libraries +*.lib +*.a +*.la +*.lo +*.def +*.exp + +# Shared objects (inc. Windows DLLs) +*.dll +*.so +*.so.* +*.dylib + +# Executables +*.exe +*.out +*.app +*.i*86 +*.x86_64 +*.hex + +# ------------------------------------------------------------------------------------- +# NodeJS +# ------------------------------------------------------------------------------------- + +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* + +# Diagnostic reports (https://nodejs.org/api/report.html) +report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage +*.lcov + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) +web_modules/ + +# TypeScript cache +*.tsbuildinfo + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Microbundle cache +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env +.env.test + +# parcel-bundler cache (https://parceljs.org/) +.cache +.parcel-cache + +# Next.js build output +.next +out + +# Nuxt.js build / generate output +.nuxt +dist + +# Gatsby files +# Uncomment the public line in if your project uses Gatsby and not Next.js +# https://nextjs.org/blog/next-9-1#public-directory-support +.cache/ +# public + +# vuepress build output +.vuepress/dist + +# Serverless directories +.serverless/ + +# FuseBox cache +.fusebox/ + +# DynamoDB Local files +.dynamodb/ + +# TernJS port file +.tern-port + +# Stores VSCode versions used for testing VSCode extensions +.vscode-test + +# yarn v2 +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +# ------------------------------------------------------------------------------------- +# Python +# ------------------------------------------------------------------------------------- + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments. Otherwise, uncomment this. +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. Uncomment if this applies to your use case. +# Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# ------------------------------------------------------------------------------------- +# Rust +# ------------------------------------------------------------------------------------- + +# Generated by Cargo +# will have compiled files and executables +debug/ +target/ + +# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries +# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html +Cargo.lock + +# These are backup files generated by rustfmt +**/*.rs.bk + + +####################################################################################### +# Tooling +####################################################################################### + +# ------------------------------------------------------------------------------------- +# JetBrain's IDEs +# ------------------------------------------------------------------------------------- + +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +# ------------------------------------------------------------------------------------- +# Packer +# ------------------------------------------------------------------------------------- + +# Cache objects +packer_cache/ + +# Crash log +crash.log + +# For built boxes +*.box + +# ------------------------------------------------------------------------------------- +# Terraform +# ------------------------------------------------------------------------------------- + +# Local .terraform directories +.terraform +.terraform.d + +# Terraform state files +# Best practice is to utilize Terraform remote state and keep the state data out of +# the repo. However, if there is no sensitive data in the state, it can sometimes +# be useful to commit the state files to the repo. Comment these out if you want to +# do that. +*.tfstate +*.tfstate.* + +# Crash log files +crash.log + +# tfvars files +# Exclude all .tfvars files, which could contain sentitive data, such as passwords, +# private keys, and other secrets. If this applies to your project, these should +# not be part of version control. +# +# Uncomment if you want this behavior. +# *.tfvars + +# Ignore override files as they are usually used to override resources locally and so +# are not checked in +override.tf +override.tf.json +*_override.tf +*_override.tf.json + +# Include override files you do wish to add to version control using negated pattern +# Uncomment to include this. +# !example_override.tf + +# Include tfplan files to ignore the plan output of command: terraform plan -out-tfplan +*tfplan* + +# Ignore CLI configuration files +.terraformrc +terraform.rc + +# ------------------------------------------------------------------------------------- +# Vim +# ------------------------------------------------------------------------------------- + +# Swap +[._]*.s[a-v][a-z] +!*.svg # comment out if you don't need vector files +[._]*.sw[a-p] +[._]s[a-rt-v][a-z] +[._]ss[a-gi-z] +[._]sw[a-p] + +# Session +Session.vim +Sessionx.vim + +# Temporary +.netrwhist +*~ +# Auto-generated tag files +tags +# Persistent undo +[._]*.un~ + +# ------------------------------------------------------------------------------------- +# Visual Studio +# ------------------------------------------------------------------------------------- + +# Ignore Visual Studio temporary files, build results, and +# files generated by popular Visual Studio add-ons. +# +# Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore +# +# Note: this is a slightly modified version of the above-reference link. + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ + +# Uncomment if you have tasks that create the project's static files in wwwroot +# wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml + +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg + +# NuGet Symbol Packages +*.snupkg + +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* + +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ + +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config + +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files files ending in .cache can be ignored +*.[Cc]ache + +# But keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk. +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +# Comment this if you want to include them. +*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +# bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +# ------------------------------------------------------------------------------------- +# Visual Studio Code +# ------------------------------------------------------------------------------------- + +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ + + +####################################################################################### +# Operating Systems +####################################################################################### + +# ------------------------------------------------------------------------------------- +# Linux +# ------------------------------------------------------------------------------------- + +# temporary files which can be created if a process still has a handle open of a +# deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + +# ------------------------------------------------------------------------------------- +# MacOS +# ------------------------------------------------------------------------------------- + +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# ------------------------------------------------------------------------------------- +# Windows +# ------------------------------------------------------------------------------------- + +# Windows thumbnail cache files +Thumbs.db +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4280d13 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,37 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + + + +Upcoming changes. + +### Added + +### Changed + +### Removed + +## [0.0.1] - YYYY-MM-DD + +Initial Release. + +### Added + +- What was added. + + + +[Unreleased]: https://github.com/timoguin/repo-template/compare/v0.0.1...HEAD +[0.0.1]: https://github.com/timoguin/repo-template/releases/tag/v0.0.1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dcfd9b1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Tim O'Guin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..85c90b8 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# Repo Template + +This repository is a very basic template for a new repository hosted on GitHub. It +contains the following boilerplate: + +- CHANGELOG.md +- LICENSE +- README.md +- GitHub CODEOWNERS +- Code of Conduct +- Contributing Guide +- Security Guide +- Empty dirs for GitHub Issue and PR templates +- Empty dir for GitHub Actions workflows +- Large .gitignore file + +## Usage + +I highly recommened the [GitHub CLI](https://cli.github.com) for interacting with the +various GitHub APIs. + +To create a new repository from this template, you can do the following: + +``` +$ gh repo create YOUR_GITHUB_USER/YOUR_GITHUB_REPO --description "A description of your repository" --template timoguin/repo-template --confirm +``` + +Since this is a very basic template, you will need to populate or modify some aspects +of the repo contents after initial creation. + +Here are the steps: + +- Update this [README]. +- Update [CODEOWNERS]. This is used by GitHub for code reviews. +- Update the [LICENSE]. By default, this template includes the MIT license text. +- Update the [CHANGELOG] to include links for your specific repository. +- Update the [Contributing Guide]. By default, this template includes text describing + an opinionated fork-based workflow. +- Update the [Code of Conduct] and insert your preferred contact method in the + [Enforcement] section. By default, this template includes the text from v2.0 of the + [Contributor Covenant]. +- Update the [Security Guide] to detail the process for reporting security issues. +- If you want to use [Issue Templates], add them to the [ISSUE_TEMPLATE] directory. +- If you want to use [Pull Request Templates], add them to the + [PULL_REQUEST_TEMPLATE] directory. +- If you want to use [GitHub Actions], add workflow definitions to the [workflows] + directory. +- Edit the [gitignore] file to your preferences. The included on is quite large and + includes a swath of patterns for various languages, tooling, and operating systems. + +And here is a sed-based method example to help with some of the more basic +search-and-replace tasks: + +``` +$ export NAME="Your Name" +$ export EMAIL="example@example.com" +$ export GITHUB_USER="YOUR_GITHUB_USER" +$ export GITHUB_REPO="YOUR_REPO" + +# For OS X, use gsed. Otherwise you will get the error "invalid command code C". See +# the below this code snippet. +alias sed=gsed + +$ echo -e "# $GITHUB_REPO\n\nThis is my README, and I hope you will READ it." > README.md +$ sed -i "s/@timoguin/@$GITHUB_USER/; s/Tim O'Guin/$NAME/; s/timoguin@gmail.com/$EMAIL/; s/timoguin\/repo-template/$GITHUB_USER\/$GITHUB_REPO/; s/2021 /$(date +'%Y') /" CHANGELOG.md LICENSE .github/CODEOWNERS .github/*.md +``` + +**NOTE**: if you are using OS X, you will need [GNU Sed] to support the -i flag for +in-place file modifications. + + + +[README]: README.md +[CODEOWNERS]: .github/CODEOWNERS +[LICENSE]: LICENSE +[CHANGELOG]: CHANGELOG.md +[Contributing Guide]: .github/CONTRIBUTING.md +[Code of Conduct]: .github/CODE_OF_CONDUCT.md +[Enforcement]: .github/CODE_OF_CONDUCT.md#Enforcement +[Contributor Covenant]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/ +[Security Guide]: .github/SECURITY.md +[Issue Templates]: https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository +[ISSUE_TEMPLATE]: .github/ISSUE_TEMPLATE +[Pull Request Templates]: https://docs.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository +[PULL_REQUEST_TEMPLATE]: .github/PULL_REQUEST_TEMPLATE +[GitHub Actions]: https://docs.github.com/en/actions +[workflows]: .github/workflows +[gitignore]: .gitignore +[GNU Sed]: https://formulae.brew.sh/formula/gnu-sed