Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (28 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.61 KB
Raw

Contributing

Thank you for your interest in SPLAT.

The artifact is frozen

splat.html is the exact byte stream inscribed on Bitcoin (Ordinal inscription #123224491). It is immutable by design and by the nature of the blockchain. It cannot and will not be modified in this repository - A pull request that changes splat.html would break the one property the whole project exists to guarantee (that the file here matches the file on-chain), and it will be closed. The verification CI enforces this automatically.

What contributions are welcome

The documentation and tooling around the artifact are open to improvement:

  • Documentation - Clarity, accuracy, typos, better verification walkthroughs, additional explorer cross-references.
  • Verification tooling - Portability fixes for scripts/verify.sh, support for more platforms, additional independent checks.
  • CI - Improvements to .github/workflows/verify.yml.

If you find a factual error in any provenance claim, that is an especially valuable report - Please open an issue or, for anything sensitive, follow SECURITY.md.

How to propose a change

  1. Open an issue describing the change, or comment on an existing one.
  2. Fork, make your change on a branch, and confirm ./scripts/verify.sh still passes.
  3. Open a pull request with a clear description of what and why.

Licensing of contributions

By contributing, you agree that your contributions to the documentation and tooling are provided under the terms of this repository's LICENSE. Contributions may not alter the PUDDY Materials or the inscribed artifact.