{"id":29193924,"url":"https://github.com/intersectmbo/hf-wg-documentation","last_synced_at":"2025-07-02T03:37:13.938Z","repository":{"id":262629395,"uuid":"887835338","full_name":"IntersectMBO/hf-wg-documentation","owner":"IntersectMBO","description":"Repository for hardfork working group documentation.","archived":false,"fork":false,"pushed_at":"2025-02-17T00:09:28.000Z","size":2645,"stargazers_count":4,"open_issues_count":0,"forks_count":12,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-17T01:20:37.787Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://cardanoupgrades.docs.intersectmbo.org/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IntersectMBO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-13T11:17:34.000Z","updated_at":"2025-02-17T00:09:31.000Z","dependencies_parsed_at":"2024-12-11T12:28:24.543Z","dependency_job_id":"deac2a0c-a08b-4e36-a550-4c1585f01846","html_url":"https://github.com/IntersectMBO/hf-wg-documentation","commit_stats":null,"previous_names":["intersectmbo/cardano-upgrades-gitbook","intersectmbo/hf-wg-documentation"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/IntersectMBO/hf-wg-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fhf-wg-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fhf-wg-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fhf-wg-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fhf-wg-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IntersectMBO","download_url":"https://codeload.github.com/IntersectMBO/hf-wg-documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fhf-wg-documentation/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263071248,"owners_count":23409255,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-02T03:37:13.188Z","updated_at":"2025-07-02T03:37:13.927Z","avatar_url":"https://github.com/IntersectMBO.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hardfork Working Group Documentation\n\nRepository for hardfork working group documentation.\n\nThis holds the source for the [cardanoupgrades.docs.intersectmbo](https://cardanoupgrades.docs.intersectmbo.org/) and polices/procedures the hardfork working group follow.\n\n## Navigation\n\n- [Cardano Upgrades Gitbook space](./gitbook/)\n- [Hardfork working group policies](./policies/)\n  - [Hardfork submission criteria](./policies/hardfork-submission-criteria.md)\n\n## Contributing\n\n### Chang #2 Updating Tooling Readiness\n\nIf you see that there is incorrect information on tooling readiness shown via [cardanoupgrades.chang-upgrade-2-readiness](https://cardanoupgrades.docs.intersectmbo.org/chang-upgrade-2/chang-upgrade-2-readiness#readiness).\n\nPlease create a pull request to update it!\n\n#### Prerequisites\n\n- [Node/NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)\n- [Gitbook CLI](https://developer.gitbook.com/cli/quickstart)\n\n#### 1. Fork the repository\n\nFrom the [Intersectmbo/hf-wg-documentation page](https://github.com/IntersectMBO/hf-wg-documentation) create a fork of the repository.\n\n#### 2. Clone the fork\n\nNavigate to the directory where you want to work from.\n\nClone the fork, substitute your github username with `YOUR_USERNAME` in the below command.\n\n```shell\ngit clone https://github.com/YOUR-USERNAME/hf-wg-documentation.git\n```\n\n#### 3. Create a branch\n\n```shell\ngit checkout -b update-status-of-my-tool\n```\n\n#### 4. Setup Gitbook to run locally\n\nNavigate into the directory.\n\n```shell\ncd hf-wg-documentation/gitbook\n```\n\nInstall required gitbook plugins\n\n```shell\ngitbook install\n```\n\n#### 5. Run locally\n\nRun and host the gitbook page locally.\n\n```shell\ngitbook serve\n```\n\nThis can then be viewed via a web browser at `http://localhost:4000`.\n\n#### 6. Make the new changes\n\nIn your favorite text editor navigate to to the readiness page.\n\nThis is how it can be done via VsCode.\n\n```shell\ncode ./chang-upgrade-2/chang-upgrade-2-readiness.md\n```\n\n#### 7. Check changes\n\nConfirming that the changes made within `./chang-upgrade-2/chang-upgrade-2-readiness.md` are impacting `http://localhost:4000` as expected.\n\n#### 8. Add, Commit and Push changes to fork\n\nIf the changes/update is working, you can commit and push the changes to your fork.\n\nAdd changes to local.\n\n```shell\ngit add .\n```\n\nCommit changes to local.\n\n```shell\ngit commit -m \"updated chang 2 readiness page\"\n```\n\nPush the changes to your fork.\n\n```shell\ngit push\n```\n\n#### 9. Create pull request from fork back to source repository\n\nFrom `https://github.com/IntersectMBO/hf-wg-documentation/compare`.\n\nEnsure you select the `compare across forks`, to be able to see your fork.\n\nSet `IntersectMBO/hf-wg-documentation` main branch as base and your fork's branch with the changes as the head.\n\nMake sure you write a good pull request description.\n\n#### 10. Review\n\nThank you for contributing.\n\n[@Ryun1](https://github.com/Ryun1) or [@IntersectMatt](https://github.com/intersectmatt) will review the request and merge.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersectmbo%2Fhf-wg-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintersectmbo%2Fhf-wg-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersectmbo%2Fhf-wg-documentation/lists"}