Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (22 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

28 lines (22 loc) · 1.2 KB
Raw

Contributing

Thanks for your interest in contributing to Cocoar.Markdown!

Getting started

  • Fork the repository and create a feature branch.
  • Requires a recent Xcode (Swift 6 toolchain, iOS 17+ / macOS 14+ SDKs).
  • Run the test suite locally before opening a PR.

The wire syntax is shared

The :::key{attr=value flag} embed-directive syntax has its NORMATIVE source in @cocoar/vue-markdown-core (cocoar-ui-vue). This repo is a byte-parity port:

  • Behavioral changes start there, as conformance vectors (embed-directive.conformance.json), then get ported here.
  • The vendored vector copy under Tests/.../Fixtures/ may only change via Scripts/sync-vectors.sh. See CONFORMANCE.md.

Testing

  • Run all tests with swift test from the repository root.
  • The demo app builds via cd Demo && xcodegen generate && xcodebuild -scheme CocoarMarkdownDemo.
  • Add tests for new features and bug fixes; parser changes need conformance vectors.

Commit/PR

  • Prefer small, focused PRs; reference related issues.
  • Use conventional commit messages (feat:, fix:, docs:, test:, etc.).

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.