summaryrefslogtreecommitdiff
path: root/wg-naming
diff options
context:
space:
mode:
authorCeleste Horgan <celeste@cncf.io>2020-10-29 20:38:21 -0700
committerCeleste Horgan <celeste@cncf.io>2020-10-29 20:41:50 -0700
commit95a3bbacf8eb5aaefda642dd4881e34bb3916a1b (patch)
tree7d1f7ee3411c7bfd9be452af9ad167fbe3884e2c /wg-naming
parent3a989ee755ef2b9b0b17caed127945ceabd9555d (diff)
Add recommendation template
Signed-off-by: Celeste Horgan <celeste@cncf.io> Co-authored-by: Aaron Crickenberger <spiffxp@google.com> Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
Diffstat (limited to 'wg-naming')
-rw-r--r--wg-naming/recommendations/template.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/wg-naming/recommendations/template.md b/wg-naming/recommendations/template.md
new file mode 100644
index 00000000..9779d80c
--- /dev/null
+++ b/wg-naming/recommendations/template.md
@@ -0,0 +1,26 @@
+# Recommendation: replace Old Term
+
+**Last Updated**: date PR was last updated, e.g. 2020-10-16
+**Status:** Accepted
+
+## Suggested Alternatives
+
+Replacements:
+- `new term`: description of where this term is applicable.
+<any additional terms>
+
+- Make the recommendation the title of the PR. For example: "Change default repository branches from 'master' to 'main'"
+- Provide a brief, 1-3 sentence summary of the reasoning for this change
+- Provide alternate recommendation(s) if needed
+
+## Context
+
+- Provide information about the recommendation. Why does this proposal matter? Who does it affect? How will it help? How does it evaluate against the [language-evaluation-framework]?
+
+## Precedents
+
+Provide any research, links to PR(s) from the Kubernetes project or other communities, standards body documents, or style guides that provide precedent for this decision.
+
+## Impact
+
+Link to the results of a [Hound](https://cs.k8s.io/) keyword search. What impact will this change create?