From 93ac2c7b2bad9fa5acf249f3e944a5a9ef024576 Mon Sep 17 00:00:00 2001 From: claire <15363063+cla-bel@users.noreply.github.com> Date: Fri, 25 Sep 2020 12:56:36 +0100 Subject: [PATCH 1/3] communications guidelines for release process --- .../release-process/smart-contracts.md | 23 ++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/packages/docs/community/release-process/smart-contracts.md b/packages/docs/community/release-process/smart-contracts.md index 2bfaaa764c4..90c747e1426 100644 --- a/packages/docs/community/release-process/smart-contracts.md +++ b/packages/docs/community/release-process/smart-contracts.md @@ -101,7 +101,8 @@ Deploying a new contract release should occur with the following process:
  • Receive report from auditors.
  • If all issues in the audit report have straightforward fixes, announce a forthcoming smart contract release.
  • Commit audit fixes to master and cherry-pick to the release branch.
    • -
  • Submit audit fixes to auditors for review.
    • +
  • Submit audit fixes to auditors for review.
    • +
  • Let the community know about the upcoming release proposal by posting details to the Governance category on https://forum.celo.org and cross post in the Discord #governance channel. See the 'Communication guidelines' section below for information on what your post should contain.
    • @@ -111,6 +112,7 @@ Deploying a new contract release should occur with the following process:
    1. Tag the release on Github.
    2. Run the smart contract release script to deploy the contracts to Baklava and submit a governance proposal.
      3. +
    3. Update your forum post with the Baklava PROPOSAL_ID, updated timings (if any changes), and notify the community in the Discord #governance channel.
    @@ -120,6 +122,7 @@ Deploying a new contract release should occur with the following process:
    1. Confirm all contracts working as intended on Baklava.
    2. Run the smart contract release script to deploy the contracts to Alfajores and submit a governance proposal.
      3. +
    3. Update your forum post with the Alfajores PROPOSAL_ID, updated timings (if any changes), and notify the community in the Discord #governance channel.
    @@ -128,7 +131,9 @@ Deploying a new contract release should occur with the following process:
    1. Confirm all contracts working as intended on Alfajores.
      2. +
    2. Confirm audit is complete and make sure your forum post contains a link to it.
    3. Run the smart contract release script to deploy the contracts to Mainnet and submit a governance proposal.
      4. +
    4. Update your forum post with the Mainnet PROPOSAL_ID, updated timings (if any changes), and notify the community in the Discord #governance channel.
    @@ -137,6 +142,7 @@ Deploying a new contract release should occur with the following process:
    1. Confirm all contracts working as intended on Mainnet.
      2. +
    2. Update your forum post with the Mainnet governance outcome (Passed or Rejected) and notify the community in the Discord #governance channel.
    @@ -144,6 +150,21 @@ Deploying a new contract release should occur with the following process: If the contents of the release (i.e. source Git commit) change at any point after the release has been tagged in Git, the process should increment the release identifier, and process should start again from the beginning. If the changes are small or do not introduce new code (e.g. reverting a contract to a previous version) the audit step may be accelerated. +### Communication guidelines + +Communicating your upcoming governance proposal to the community is critical and may help getting it approved. + +Each smart contract release governance proposal should be accompanied by a [Governance category](https://forum.celo.org/c/governance/) forum post that contains the following information: +* Name of proposer (individual contributor or organization). +* Background information. +* Link to the release notes. +* Link to the audit report(s). +* Anticipated timings for the Baklava and Alfajores testnets and Mainnet. + +It's recommended to post as early as possible and at minimum one week before the anticipated Baklava testnet governance proposal date. + +Make sure to keep the post up to date. All updates (excluding fixing typos) should be communicated to the community in the [Discord](http://chat.celo.org/) `#governance` channel. + ### Emergency patches {% hint style="warning" %} From 8257497d9ea214d3d6be3d400333c670cee275e5 Mon Sep 17 00:00:00 2001 From: claire <15363063+cla-bel@users.noreply.github.com> Date: Fri, 25 Sep 2020 20:02:51 +0200 Subject: [PATCH 2/3] Update smart-contracts.md --- packages/docs/community/release-process/smart-contracts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/community/release-process/smart-contracts.md b/packages/docs/community/release-process/smart-contracts.md index 90c747e1426..712fe1e52b1 100644 --- a/packages/docs/community/release-process/smart-contracts.md +++ b/packages/docs/community/release-process/smart-contracts.md @@ -152,7 +152,7 @@ If the contents of the release (i.e. source Git commit) change at any point afte ### Communication guidelines -Communicating your upcoming governance proposal to the community is critical and may help getting it approved. +Communicating the upcoming governance proposal to the community is critical and may help getting it approved. Each smart contract release governance proposal should be accompanied by a [Governance category](https://forum.celo.org/c/governance/) forum post that contains the following information: * Name of proposer (individual contributor or organization). From 81ea7cc82a2289730254fef662e60e3df289c273 Mon Sep 17 00:00:00 2001 From: Nam Chu Hoai Date: Fri, 25 Sep 2020 15:09:46 -0400 Subject: [PATCH 3/3] Add link to governance channel --- packages/docs/community/release-process/smart-contracts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/community/release-process/smart-contracts.md b/packages/docs/community/release-process/smart-contracts.md index 712fe1e52b1..5aa466f5752 100644 --- a/packages/docs/community/release-process/smart-contracts.md +++ b/packages/docs/community/release-process/smart-contracts.md @@ -102,7 +102,7 @@ Deploying a new contract release should occur with the following process:
  • If all issues in the audit report have straightforward fixes, announce a forthcoming smart contract release.
  • Commit audit fixes to master and cherry-pick to the release branch.
  • Submit audit fixes to auditors for review.
    • -
  • Let the community know about the upcoming release proposal by posting details to the Governance category on https://forum.celo.org and cross post in the Discord #governance channel. See the 'Communication guidelines' section below for information on what your post should contain.
    • +
  • Let the community know about the upcoming release proposal by posting details to the Governance category on https://forum.celo.org and cross post in the Discord #governance channel. See the 'Communication guidelines' section below for information on what your post should contain.