Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add ecosystem service credit RFC + RFC template #107

Merged
merged 31 commits into from
Aug 18, 2021
Merged

Conversation

clevinson
Copy link
Member

@clevinson clevinson commented May 22, 2020

ref #78

Proposed Changes

  • Adds Ecosystem Service Credit RFC from google doc to .md file for archiving & visiblity
  • Adds RFC folder
  • Adds template for future RFCs

Feel free to submit a Draft Pull Request as soon as you start working on something. Before you mark your PR as Ready For Review, make sure you've checked off the following boxes or indicated N/A (not applicable):

  • linked to a relevant issue or have written a clear description of the issue in the PR
  • wrote or updated tests
  • wrote or updated documentation
  • added an appropriate entry in CHANGELOG.md following https://keepachangelog.com

Thanks!

@clevinson clevinson requested a review from aaronc May 22, 2020 00:30
@codecov
Copy link

codecov bot commented May 22, 2020

Codecov Report

Merging #107 (7201fb3) into master (7287f51) will decrease coverage by 15.86%.
The diff coverage is n/a.

❗ Current head 7201fb3 differs from pull request most recent head c72cb69. Consider uploading reports for the commit c72cb69 to get more accurate results

@@             Coverage Diff             @@
##           master     #107       +/-   ##
===========================================
- Coverage   76.90%   61.03%   -15.87%     
===========================================
  Files         101       91       -10     
  Lines       12522     9021     -3501     
===========================================
- Hits         9630     5506     -4124     
- Misses       2288     3042      +754     
+ Partials      604      473      -131     
Flag Coverage Δ
experimental-codecov ?
stable-codecov 61.03% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

aaronc
aaronc previously requested changes May 26, 2020
Copy link
Member

@aaronc aaronc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a README.md that indexes the RFC's? Maybe include a link in the README &/or template to the RFC process we're trying to follow.

@aaronc aaronc added the backlog label Aug 17, 2020
@aaronc aaronc mentioned this pull request Aug 19, 2020
7 tasks
@aaronc aaronc changed the title Add RFC folder, with credit RFC and template for future RFCs Add ecosystem service credit RFC + RFC template Aug 19, 2020
@robert-zaremba
Copy link
Collaborator

Great overview and intro.
What's the reason of having this PR open? It's hard to read text docs in PR, and even harder to comment on the general structure).
Shall we merge this PR and iterate?

Also, is there any difference between this document and the RFC: Ecosystem Service Credit Module Google Doc? Would be good to keep things in one place, otherwise one will get outdated. So... maybe we should point from one document to another, and in the slave one remove the common content (maybe except the abstract) and point to the master document.

@robert-zaremba
Copy link
Collaborator

robert-zaremba commented Oct 1, 2020

To be honest, I find it easier to read the spec docs in a more "Higher level" doc management system, like:

  • dropbox paper
  • google doc (has an advantage of "suggest mode")
  • hackmd

All solutions above have a nice commenting system and also allow to trace edits with notifications / emails.

The advantage of each of that systems is that we observe a single working document rather than bunch of issues and pull-requests.

@aaronc
Copy link
Member

aaronc commented Nov 2, 2020

Could you add a README @clevinson and then we'll merge as is and iterate if needed?

@robert-zaremba
Copy link
Collaborator

I think there were few updates in the Google Doc, could be good to port them and freeze the google doc.

@aaronc
Copy link
Member

aaronc commented Nov 24, 2020

Ping @clevinson

@amaury1093
Copy link
Contributor

Is this PR actually R4R? What should we do about it?

@clevinson clevinson removed the backlog label Jul 21, 2021
@clevinson clevinson changed the title Add ecosystem service credit RFC + RFC template docs: add ecosystem service credit RFC + RFC template Jul 27, 2021
@clevinson clevinson requested a review from aaronc July 27, 2021 01:26
@clevinson
Copy link
Member Author

Updated w/ @aaronc feedback adding a README & pushing this R4R again! I'd love to get this merged finally :)

Happy to iterate on this in the future, but my preference is that we start with this process (maybe initially with the ecocredit updates that we've already discussed implementing?), and then look to iterating once we have some momentum on creating these documents again.

@clevinson clevinson linked an issue Jul 27, 2021 that may be closed by this pull request
Copy link
Member

@ryanchristo ryanchristo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. A few minor suggestions but nothing blocking.

rfcs/001-ecosystem-serfice-credit-module.md Outdated Show resolved Hide resolved
rfcs/README.md Outdated Show resolved Hide resolved
rfcs/README.md Outdated Show resolved Hide resolved
rfcs/000-template.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-serfice-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-serfice-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-serfice-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-serfice-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-serfice-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-serfice-credit-module.md Outdated Show resolved Hide resolved
@ryanchristo
Copy link
Member

Just noticed a typo in the filename: 001-ecosystem-serfice-credit-module.md

Copy link
Contributor

@technicallyty technicallyty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few nits, pre-approving

rfcs/001-ecosystem-service-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-service-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-service-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-service-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-service-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-service-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-service-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-service-credit-module.md Outdated Show resolved Hide resolved
rfcs/001-ecosystem-service-credit-module.md Show resolved Hide resolved

## Complex State Machines

Another design decision made in this proposal was to only implement two possible states for credits: “tradable” and “retired”. These are the two known states that we need to be able to manage for our first use case with the registry. While it is assumed that there may be more complex state machines that we will need to support at a later date, we chose to start with satisfying the current use case for the same reasons illustrated above (reducing complexity, and allowing future use cases to drive more complex functionality or generalizations).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Another design decision made in this proposal was to only implement two possible states for credits: “tradable” and “retired”. These are the two known states that we need to be able to manage for our first use case with the registry. While it is assumed that there may be more complex state machines that we will need to support at a later date, we chose to start with satisfying the current use case for the same reasons illustrated above (reducing complexity, and allowing future use cases to drive more complex functionality or generalizations).
Another design decision made in this proposal was to only implement two possible states for credits: “tradable” and “retired”. These are the two known states that we need to be able to manage for our first use case with the registry. While it is assumed there may be more complex states that we will need to support at a later date, we chose to start with satisfying the current use case for the same reasons illustrated above (reducing complexity, and allowing future use cases to drive more complex functionality or generalizations).

i think you meant only states here instead of state machines?

Copy link
Member Author

@clevinson clevinson Aug 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No - meant state machines (Right now the state machine is tradable -> retired, as the only allowable state transition possible). It may be in the future that we have other state transitions possible (to newly defined states).

@clevinson
Copy link
Member Author

Thanks @ryanchristo @technicallyty !

@clevinson clevinson enabled auto-merge (squash) August 18, 2021 03:08
@clevinson clevinson merged commit 4198cd4 into master Aug 18, 2021
@clevinson clevinson deleted the add-rfcs branch August 18, 2021 03:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Specification Ecosystem Service Credit
6 participants