Hardfork Working Group Documentation

Repository for hardfork working group documentation.

This holds the source for the cardanoupgrades.docs.intersectmbo and polices/procedures the hardfork working group follow.

Navigation

• Cardano Upgrades Gitbook space
• Hardfork working group policies
  • Hardfork submission criteria

Contributing

Chang #2 Updating Tooling Readiness

If you see that there is incorrect information on tooling readiness shown via cardanoupgrades.chang-upgrade-2-readiness.

Please create a pull request to update it!

Prerequisites

• Node/NPM
• Gitbook CLI

1. Fork the repository

From the Intersectmbo/hf-wg-documentation page create a fork of the repository.

2. Clone the fork

Navigate to the directory where you want to work from.

Clone the fork, substitute your github username with YOUR_USERNAME in the below command.

git clone https://github.com/YOUR-USERNAME/hf-wg-documentation.git

3. Create a branch

git checkout -b update-status-of-my-tool

4. Setup Gitbook to run locally

Navigate into the directory.

cd hf-wg-documentation/gitbook

Install required gitbook plugins

gitbook install

5. Run locally

Run and host the gitbook page locally.

gitbook serve

This can then be viewed via a web browser at http://localhost:4000.

6. Make the new changes

In your favorite text editor navigate to to the readiness page.

This is how it can be done via VsCode.

code ./chang-upgrade-2/chang-upgrade-2-readiness.md

7. Check changes

Confirming that the changes made within ./chang-upgrade-2/chang-upgrade-2-readiness.md are impacting http://localhost:4000 as expected.

8. Add, Commit and Push changes to fork

If the changes/update is working, you can commit and push the changes to your fork.

Add changes to local.

git add .

Commit changes to local.

git commit -m "updated chang 2 readiness page"

Push the changes to your fork.

git push

9. Create pull request from fork back to source repository

From https://github.com/IntersectMBO/hf-wg-documentation/compare.

Ensure you select the compare across forks, to be able to see your fork.

Set IntersectMBO/hf-wg-documentation main branch as base and your fork's branch with the changes as the head.

Make sure you write a good pull request description.

10. Review

Thank you for contributing.

@Ryun1 or @IntersectMatt will review the request and merge.