Structure for our tsc and project management documents #55
Closed
hendrikebbers
started this conversation in
Ideas
Replies: 2 comments
-
In other communities we recommend using Wikis for non-technical contributions. It is easy to collaborate to and will be a better option to visualize documentation for the repo. Let me know what do you think |
Beta Was this translation helpful? Give feedback.
0 replies
-
This is updated in hiero-ledger/governance#288 similarly to how we do it in other communities |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Today, many informal documents are stored as markdown files in the root of the https://github.com/hiero-ledger repo. Next, the latest version of the charter (including its date) is stored in the https://github.com/hiero-ledger/governance repo. While that was ok for the start, we should define a better structure for all those documents.
Technical Charter
LFDT defines the charter as part of the
governance
repository. The problem with the current file is that it includes the date in the filename (Hiero Technical Charter Final 9-16-2024.md
), making it impossible to link to the latest / active charter. Therefore, I suggest creating a hiero-technical-charter.md file directly in the root of thegovernance
repo that always contains the latest version. Next to that, we can make a folder calledcharter-history
that includes all versions (likeHiero Technical Charter Final 9-16-2024.md
).Other official documents
We have created some documents that define rules and criteria for the project onboarding (https://github.com/hiero-ledger/hiero/blob/main/howto-transfer.md + #54). Since the TSC voted on those documents, I suggest moving them to the
governance
repository in aproject-onboarding
folder.General structure
In the future, we should place all information on that the TSC voted on as markdown files in the
governance
repository and create a meaningful folder structure. We could even create a webpage out of that in a future step.Beta Was this translation helpful? Give feedback.
All reactions