docs: tip-1: Tari Improvement Proposals#164
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces the Tari Improvement Proposal (TIP) process by adding TIP-1, which defines the workflow, roles, and statuses for community-driven improvements. It also includes stubs for TIP-2 and TIP-3, updates the project's about page to differentiate between RFCs and TIPs, and adjusts the README to include mdbook-mermaid in the build instructions. Feedback on the new documentation highlighted a logic error in the Arbiter definition, residual references to the Open edX community, and several typos and formatting issues in the TIP-1 metadata tables.
|
|
||
| ### Under Review | ||
|
|
||
| The TIP is under discussion and being reviewed by the Open edX community, the Arbiter, and the Authors. |
There was a problem hiding this comment.
This appears to be a copy-paste error from the source OEP document. It should refer to the "Tari community" instead of the "Open edX community".
| The TIP is under discussion and being reviewed by the Open edX community, the Arbiter, and the Authors. | |
| The TIP is under discussion and being reviewed by the Tari community, the Arbiter, and the Authors. |
| | Last Modified | <date string, in YYYY-MM-DD format> | | ||
| | Authors | <list of authors' established handles or names, and, optionally, email addresses> | | ||
| | Arbiter | <Arbiter's established handle or name and email address> | | ||
| | Status | <Draft \| Under Review \| Deferred \| Accepted \| Replaced \| Provisional | |
There was a problem hiding this comment.
The placeholder list for the Status field is missing its closing bracket >.
| | Status | <Draft \| Under Review \| Deferred \| Accepted \| Replaced \| Provisional | | |
| | Status | <Draft \| Under Review \| Deferred \| Accepted \| Replaced \| Provisional> | |
Kelketek
changed the title
Kelketek
force-pushed
the
fox/tip-1-tari-improvement-proposals
branch
from
9070494 to
2a0991d
Compare
Kelketek
force-pushed
the
fox/tip-1-tari-improvement-proposals
branch
3 times, most recently
from
9aa2411 to
4ec90d3
Compare
Kelketek
changed the title
Kelketek
force-pushed
the
fox/tip-1-tari-improvement-proposals
branch
from
969444c to
881e0ba
Compare
Signed-off-by: Fox Danger Piacenti <fox@opencraft.com>
Signed-off-by: Fox Danger Piacenti <fox@opencraft.com>
Kelketek
force-pushed
the
fox/tip-1-tari-improvement-proposals
branch
from
881e0ba to
50d79a0
Compare
Kelketek
force-pushed
the
fox/tip-1-tari-improvement-proposals
branch
from
2caf72e to
ec5075c
Compare
| ### Needs Revision (NR) | ||
|
|
||
| Over time, some TIPs may stay relevant - for example, they may have many sections or core ideas that are still relevant | ||
| to the project - while containing many details that have become stale over time. When we are in agreement that the TIP | ||
| needs updating, we can use this status to indicate to those browsing TIPs that this particular one requires some | ||
| renewed attention. | ||
|
|
||
| When changing status to "Needs Revision", a row titled "Revision Ticket" should be added to the preamble (directly | ||
| under the status field.) This field should link the GitHub issue, forum post, or pull request in the | ||
| [RFCs repository] that describes what about the TIP needs to be revised. |
There was a problem hiding this comment.
I feel like this might get misued and used as an excuse to not update the rfc. I would prefer a hard rule that if consensus or something changes, a pr needs to accompany the other pr to update the rfc.
| | Authors | <list of authors' established handles or names, and, optionally, email addresses> | | ||
| | Reviewer | <Expert Reviewer's established handle or name and email address> | |
There was a problem hiding this comment.
I would remove this, from the current rfc's they just get out of date and dont get updated.
We have two things here, git history to track this, and we can add the authors to history.
SWvheerden
changed the title
2 participants
Description
This creates TIP-1, the first Tari Improvement Proposal, which establishes a process for creating Tari Improvement Proposals.
Motivation and Context
Contained within the PR's contents.
Dependencies
This PR depends on this PR for its structure.
How Has This Been Tested?
Manually.