Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (31 loc) · 979 Bytes

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 979 Bytes
Raw

Contributing

Thanks for your interest in contributing to the Data Contract app!

Getting Started

  1. Fork the repository
  2. Clone your fork
  3. Run ./start-data-contract.sh to install dependencies and start the dev server
  4. Make your changes
  5. Submit a pull request

Development

The app is built with SvelteKit 5 + Svelte 5 runes, Tailwind CSS 4, and TypeScript.

cd app
npm install
npm run dev -- --port 5119

What to Contribute

  • Bug fixes
  • Accessibility improvements
  • New export formats (e.g. additional ODCS / OpenMetadata language modules)
  • Additional example contracts
  • Documentation improvements
  • Translation / i18n

Code Style

  • TypeScript with strict mode
  • Svelte 5 runes ($state, $derived, $effect)
  • Tailwind CSS for styling
  • No unnecessary abstractions — keep it simple

Licensing

By contributing, you agree that your contributions will be licensed under:

  • Code: MIT License
  • Documentation: CC BY-SA 4.0