summaryrefslogtreecommitdiff
path: root/docs/proposals/README.md
diff options
context:
space:
mode:
authorTheresa Foley <10618364+tangent-vector@users.noreply.github.com>2022-05-10 16:45:07 -0700
committerGitHub <noreply@github.com>2022-05-10 16:45:07 -0700
commitdc541cc10783de541d8341b5fccee4c6019b5c6e (patch)
treee9f992632c356c3dd5cb09f6e77610fb445b4a51 /docs/proposals/README.md
parent2eff11b040077b3e7c647a519d4f313871a92674 (diff)
Add design proposal for basic interfaces. (#2229)
This change adds a `docs/proposals/` directory to give us a place to iterate on proposals for language/compiler features that are a bit too large to handle as issues. The first proposal I'm checking in here is a sketch of what our built-in numeric interfaces might want to look like. I do not propose that the design in the document is perfect or even *finished*. The goal here is to get things checked into source control to foster subsequent discussion and iteration.
Diffstat (limited to 'docs/proposals/README.md')
-rw-r--r--docs/proposals/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/proposals/README.md b/docs/proposals/README.md
new file mode 100644
index 000000000..9df8052c4
--- /dev/null
+++ b/docs/proposals/README.md
@@ -0,0 +1,8 @@
+Proposals
+=========
+
+This directory contains proposals / "RFCs" for Slang language/compiler/system features.
+In general, proposals are used for features that are large or complicated enough that the design and/or plan benefits from being discussed in detail before we commit to making code changes.
+
+Design *discussion* can often be facilitated by a GitHub/GitLab issue, or PR review comments, but often it is difficult for a developer to get a clear summary of the final decisions/POR without reading an entire discussion thread.
+By framing design discussion around a document that captures the decisions, we hope to ensure that the at the end of the discussion we have useful collateral for anybody who goes to implement a feature.