abcxyz / abcxyz/abc

Template Subfolder convention in README/existing templates

Open
#166 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Go
Stars
16
Forks
4
PR merge metrics
No merged PRs in 30d

Description

### TL;DR

Establish a recommended convention of having template files that are intended to be included placed in a subfolder one directory below the spec.yaml. This way, other files that are repo-specific (such as .vscode and .gitignore) or metadata for the template won't need to be excluded as part of the spec.yaml (for example, imagine a README.md for describing how to use the template on the same level as the spec.yaml and another README.md in the template folder meant to be included in the render describing details about the template code). However, this shouldn't be strictly enforced, providing some flexibility to template authors as there could be some templates that have a need for follow up actions, different files for different environments, other layout requirements, etc.

Context: https://docs.google.com/document/d/12iN2g1Idz6fW5ZqaokTmSFZf5kHXaWeewULWy2q5GfE/edit#heading=h.z1xyeclrumgj

### Detailed design

_No response_

### Alternatives considered

_No response_

### Additional information

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.