CONTRIBUTING.md

Contributing to Chain-Toolkit

Thank you for your interest in contributing to Chain-Toolkit! We appreciate all contributions, big or small.

---

Table of Contents

1. Getting Started
2. How to Contribute
   • Adding Network Configurations
3. Code Style
4. Pre Commit
5. Need Help?

---

Getting Started

1. Fork the repository: Click the "Fork" button in the top-right corner of the repository page.

2. Clone your fork:

   git clone https://github.com/niZmosis/chain-toolkit.git

3. Create a branch:

   git checkout -b my-new-branch

4. Run the following command to set up the project:

   pnpm setup:initial

5. Start watching all packages:

   pnpm start

6. Make your changes:

   • Follow the code style guidelines.
   • Write clear commit messages.

7. Push your changes:

   git push origin my-new-branch

8. Open a pull request: Go to the original repository and click "New pull request."

---

How to Contribute

Check the TODO.md file to see the current list of tasks.

Adding Network Configurations

1. Add the Chain ID to chainIds.ts

2. Add the Network Config to networks

   • Ensure to add the Network config to getChainConfig at the bottom of the file.
   • If adding a new network, export it in the barrel file.

3. Add the Network Icon to images

4. Add the created Network Config to getChainConfig in chainConfigs

5. Run Tests:

   pnpm test:utils:networks

6. Update the compatibility table in the README.md README.md

Code Style

• Keep items in alphabetical order where applicable.

---

Pre Commit

Before committing, run

pnpm precommit

to preform all linting, formatting, docs, and tests.

Need Help?

If you have any questions or need help getting started, feel free to open an issue or contact us on [communication channel, e.g., Discord].