Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (13 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

20 lines (13 loc) · 1.17 KB
Raw

Contributing to HTMT

HTMT is an early working draft. Contributions — corrections, clarifications, new attribute proposals, and feedback on the design — are welcome.

How to contribute

  • Discuss first. For anything beyond a small fix, open a GitHub issue describing the problem or proposal before writing a pull request.
  • Branches. Development happens on develop; main is fast-forwarded from it. Target pull requests at develop.
  • Scope. Keep each pull request to one logical change.

Documentation conventions

  • Each attribute is documented in its own file under docs/ (e.g. docs/ht-bind.md), with a description, its syntax, and at least one example.
  • Binding expressions use JSONPath (e.g. $.user.name).
  • When adding or renaming an attribute, update the features table in the README to match the docs/ pages.
  • Add an entry to CHANGELOG.md (Keep a Changelog format) for any change to the attribute set or its semantics.

License

By contributing, you agree that your contributions are licensed under the MIT License.