pull_request_template.md

Thank you for contributing to Spellbook!

Thank you for taking the time to submit code in Spellbook. A few things to consider:

• If you are a first-time contributor, please sign the CLA by copy & pasting exactly what the bot mentions in PR comment
• Refer to docs section below to answer questions
• Dune team will review submitted PRs as soon as possible

Spellbook sub-projects

To prepare for Spellbook to scale in size, Dune team has started to pilot sub-projects:

• For a quick overview, see the GH discussion on the topic
  • Please ask questions and continue the conversation there
• The first spell lineage to move: tokens.erc20 and all upstream spells which help build it
  • Note: Please navigate to tokens root directory to find tokens objects

Spellbook contribution docs

The docs directory has been implemented to answer as many questions as possible. Please take the time to reference each .md file within this directory to understand how to efficiently contribute & why the repo is designed as it is 🪄

Example questions to be answered:

• What does each property in the model config block mean?
• What is the CI test attached to PRs and how can I best utilize it?
• What are the Spellbook best practices?

Please navigate through the docs directory to find as much info as you can.

Note: happy to take PRs to improve the docs, let us know 🤝