Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.11 KB
Raw

Contributing

Thanks for helping improve the testnet examples. This repo is meant to stay small and readable: short, heavily commented recipes that each do one thing.

Ground rules

  • Testnet only. Never commit a real seed phrase, private key, or mainnet address. Every key here is a throwaway.
  • One recipe, one idea. Keep each script focused and easy to read top to bottom.
  • Match the existing style: same structure, same comment density, plain language.

Before you open a pull request

Run the same checks CI runs.

Python:

python -m compileall -q python

JavaScript:

for f in javascript/*.js; do node --check "$f"; done
cd javascript && npm install && node 00_new_key.js   # offline smoke test

Adding a recipe

  • Add it in both python/ and javascript/ where it makes sense, numbered to match.
  • Update the run list in python/README.md and javascript/README.md, and the table in the top-level README.md.
  • Link it to the matching TestnetHub guide if there is one.

Questions

Open an issue, or read the guides at testnethub.com.