diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 25f0bc5..0000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: ๐Ÿ› Bug Report -about: Thank you for taking the time, please report a reproducible bug -title: "[Bug] " -labels: bug -assignees: add codeowner's @name here - ---- - -**Describe the bug** -*A clear and concise description of what the bug is.* - -**To Reproduce:** -*Steps to reproduce the behavior:* -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior:** -*A clear and concise description of what you expected to happen.* - -**Supporting Material** -*If applicable, add screenshots, output log and/or other documentation to help explain your problem.* - -**Environment (please complete the following information):** - - OS: [ex: iOS] - - Version - -**Additional context** -Add any other context that you feel is relevant about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 0ba9db2..144207a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ contact_links: - - name: โ“ Questions and Help ๐Ÿค” - url: https://discord.gg/block-opensource (/add your discord channel if applicable) - about: This issue tracker is not for support questions. Please refer to the community for more help. + - name: Questions and help + url: https://discord.gg/block-opensource + about: Ask questions in the Block open source Discord. Use issues for problems in the protocol documents. diff --git a/.github/ISSUE_TEMPLATE/protocol-problem.md b/.github/ISSUE_TEMPLATE/protocol-problem.md new file mode 100644 index 0000000..32bd01a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/protocol-problem.md @@ -0,0 +1,26 @@ +--- +name: Problem in the protocol +about: A rule that is wrong, unclear, contradicts another document, or cannot be implemented +title: "" +labels: "" +--- + +**Document and section** + +For example: HOST.md ยง3 Writing. + +**The problem** + +What is wrong, unclear, or contradictory? Quote the text. + +**What happened** + +If you found this while building or testing a host, which host and which release (for example `v0.1.0`)? Which black-box test, if any? + +**What you suggest** + +Optional. + +**Sovereignty impact** + +Does the problem weaken any commitment in SOVEREIGNTY.md? Which one? diff --git a/CODEOWNERS b/CODEOWNERS index 6f2e6f3..62c2244 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,24 +1,4 @@ -# This CODEOWNERS file denotes the project leads -# and encodes their responsibilities for code review. +# Project leads. They review every change. +# Format: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners -# Instructions: At a minimum, replace the '@GITHUB_USER_NAME_GOES_HERE' -# here with at least one project lead. - -# Lines starting with '#' are comments. -# Each line is a file pattern followed by one or more owners. -# The format is described: https://github.blog/2017-07-06-introducing-code-owners/ - -# These owners will be the default owners for everything in the repo. * @daveh-beep - - -# ----------------------------------------------- -# BELOW THIS LINE ARE TEMPLATES, UNUSED -# ----------------------------------------------- -# Order is important. The last matching pattern has the most precedence. -# So if a pull request only touches javascript files, only these owners -# will be requested to review. -# *.js @octocat @github/js - -# You can also use email addresses if you prefer. -# docs/* docs@example.com \ No newline at end of file diff --git a/EXPERIMENTS.md b/EXPERIMENTS.md index d77f84d..7b4709f 100644 --- a/EXPERIMENTS.md +++ b/EXPERIMENTS.md @@ -104,4 +104,6 @@ Every experiment must identify: - [0009 โ€” Serve one store from two hosts](./experiments/0009-serve-one-store-from-two-hosts.md) - [0010 โ€” Produce a person-shaped briefing](./experiments/0010-produce-a-person-shaped-briefing.md) +Numbers are identifiers, not a sequence. Gaps are expected. + Use the [experiment template](./experiments/TEMPLATE.md) to propose another small test. diff --git a/experiments/0009-serve-one-store-from-two-hosts.md b/experiments/0009-serve-one-store-from-two-hosts.md index 3dac2d9..9cc076e 100644 --- a/experiments/0009-serve-one-store-from-two-hosts.md +++ b/experiments/0009-serve-one-store-from-two-hosts.md @@ -1,4 +1,4 @@ -# Experiment 0009 โ€” Serve one store from two hosts +# Experiment 0009: Serve one store from two hosts **Status:** Proposed **Contract under test:** [HOST.md](../HOST.md) diff --git a/experiments/0010-produce-a-person-shaped-briefing.md b/experiments/0010-produce-a-person-shaped-briefing.md index 926e0e3..e51dbdb 100644 --- a/experiments/0010-produce-a-person-shaped-briefing.md +++ b/experiments/0010-produce-a-person-shaped-briefing.md @@ -1,4 +1,4 @@ -# Experiment 0010 โ€” Produce a person-shaped briefing +# Experiment 0010: Produce a person-shaped briefing **Status:** Proposed **Contract under test:** [BRIEFING.md](../BRIEFING.md)