From afbfac45136f0b5117f57cf8a61f8772167bd672 Mon Sep 17 00:00:00 2001 From: Tyler Davis Date: Mon, 6 Dec 2021 02:34:14 +0000 Subject: chore: add first parts of framework Initial framework, covering languages and core-rules standards --- CONTRIBUTING.md | 8 ++++++++ README.md | 3 +++ apis.md | 0 deployment.md | 0 docs/continuous-deployment.md | 0 docs/datastores.md | 0 docs/language.md | 0 docs/languages/golang.md | 0 docs/languages/java.md | 0 docs/languages/nodejs.md | 0 docs/languages/python.md | 0 docs/languages/rust.md | 0 monitoring-and-alerting.md | 0 secrets.md | 0 tiers.md | 0 15 files changed, 11 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 apis.md create mode 100644 deployment.md create mode 100644 docs/continuous-deployment.md create mode 100644 docs/datastores.md create mode 100644 docs/language.md create mode 100644 docs/languages/golang.md create mode 100644 docs/languages/java.md create mode 100644 docs/languages/nodejs.md create mode 100644 docs/languages/python.md create mode 100644 docs/languages/rust.md create mode 100644 monitoring-and-alerting.md create mode 100644 secrets.md create mode 100644 tiers.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7d76a6d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Contribution Guide + +*Note: [RFC2119](https://www.rfc-editor.org/rfc/rfc2119.txt)* + +Engineering Standards are most useful when they are constructed, modified, and aligned to an organization's purpose. +To build these according to your organization's needs and purposes, clone this repository, modify or create a new file, and then generate a Pull Request (hence, PR) or the equivalent for your source-code system. +Per the core rules, Stakeholders in the OWNERS file will review the PRs within the declared time frame and either provide feedback or give approval to merge the change. +While violations to this merging rule MAY be permitted by business process, this is discouraged. diff --git a/README.md b/README.md index 4a0c339..49272a3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,5 @@ # standards + Standards for Engineering Software + +All standards documents follow [RFC2119](https://www.rfc-editor.org/rfc/rfc2119.txt). diff --git a/apis.md b/apis.md new file mode 100644 index 0000000..e69de29 diff --git a/deployment.md b/deployment.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/continuous-deployment.md b/docs/continuous-deployment.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/datastores.md b/docs/datastores.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/language.md b/docs/language.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/languages/golang.md b/docs/languages/golang.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/languages/java.md b/docs/languages/java.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/languages/nodejs.md b/docs/languages/nodejs.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/languages/python.md b/docs/languages/python.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/languages/rust.md b/docs/languages/rust.md new file mode 100644 index 0000000..e69de29 diff --git a/monitoring-and-alerting.md b/monitoring-and-alerting.md new file mode 100644 index 0000000..e69de29 diff --git a/secrets.md b/secrets.md new file mode 100644 index 0000000..e69de29 diff --git a/tiers.md b/tiers.md new file mode 100644 index 0000000..e69de29 -- cgit v1.2.3