From a00bb847b8545b0f99380913068bcfd09acc843e Mon Sep 17 00:00:00 2001 From: Hugo Caillard <911307+hugocaillard@users.noreply.github.com> Date: Fri, 16 Jun 2023 17:56:49 +0200 Subject: [PATCH 1/3] docs: add contributing guidelines --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 719b9a1..ecf5825 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,25 @@ This repository is the primary reference for the Clarity language. Note that this reference is not normative. It may include details that are specific to the Stacks blockchain implementation of Clarity itself, and should not be taken as a specification for the Clarity language. Such a specification may come someday, but this is what we have for now. You can read [the language reference](https://github.com/clarity-lang/reference/blob/master/reference.md). + +# Contributing + +Anyone can open issues on this repository to suggest improvements to the Clarity language. +The point is to have early discussions here before moving to an actual SIP. + +- Make sure that a similar issue doesn't already exists (check the closed ones) +- Be specific +- Give use cases and usage exemples + +## From candidate to SIP + +Once an issue is opened, it can have the tag `clarity-3-candidate`, meaning that the idea will be considered to be added to the updcoming version clarity. +While the issue has this tag, it's time to debate, brainstorm and improve the specification. + +Moving forward, the proposal will fall under one of these tags: +- `need-refinement` the proposal isn't specific enough and nee to be refined +- `sip-in-progress` meaning that the candidate will be promoted to a SIP +- `icebox` meaning that this idea won't be included in the next Clarity version but maybe in later ones +- `wontfix` this idea will not be included in Clarity (and close the issue). + +The Blockchain team should be responsible for setting this tags. From 6e0428abd9708086f037a8b7bbe422ff2952193c Mon Sep 17 00:00:00 2001 From: Hugo C <911307+hugocaillard@users.noreply.github.com> Date: Wed, 13 Sep 2023 15:02:38 +0200 Subject: [PATCH 2/3] docs: update README.md Co-authored-by: Brice Dobry --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ecf5825..874ba70 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ The point is to have early discussions here before moving to an actual SIP. ## From candidate to SIP -Once an issue is opened, it can have the tag `clarity-3-candidate`, meaning that the idea will be considered to be added to the updcoming version clarity. +Once an issue is opened, it can have the tag `clarity-3-candidate`, meaning that the idea will be considered to be added to the upcoming version clarity. While the issue has this tag, it's time to debate, brainstorm and improve the specification. Moving forward, the proposal will fall under one of these tags: From e24a93b09cdb0e720f9a68766c267fc4ef312fa8 Mon Sep 17 00:00:00 2001 From: Hugo C <911307+hugocaillard@users.noreply.github.com> Date: Thu, 10 Jul 2025 18:15:30 +0200 Subject: [PATCH 3/3] refactor: review Co-authored-by: Brice --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 874ba70..e82cc3f 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,11 @@ The point is to have early discussions here before moving to an actual SIP. - Make sure that a similar issue doesn't already exists (check the closed ones) - Be specific -- Give use cases and usage exemples +- Give use cases and usage examples ## From candidate to SIP -Once an issue is opened, it can have the tag `clarity-3-candidate`, meaning that the idea will be considered to be added to the upcoming version clarity. +Once an issue is opened, it can have the tag `clarity-3-candidate`, meaning that the idea will be considered to be added to the upcoming version of Clarity. While the issue has this tag, it's time to debate, brainstorm and improve the specification. Moving forward, the proposal will fall under one of these tags: @@ -26,4 +26,4 @@ Moving forward, the proposal will fall under one of these tags: - `icebox` meaning that this idea won't be included in the next Clarity version but maybe in later ones - `wontfix` this idea will not be included in Clarity (and close the issue). -The Blockchain team should be responsible for setting this tags. +The Blockchain team should be responsible for setting these tags.