Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 2.17 KB

Contributing.md

File metadata and controls

57 lines (42 loc) · 2.17 KB

Contributing to www.yaml.org

The upkeep of https://www.yaml.org is a community project. You can easily contribute! Just fork, make changes and send us a Pull Request.

Changing the YAML Specfication files

The YAML specs are published on yaml.org from this repository, but the source files for modifying them are located here: https://github.com/yaml/yaml-spec. Please submit spec related pull requests there.

Adding a YAML library to index.html

Thanks for adding a library we don't yet know about! Please help making the list of libraries more useful.

Please note that it makes it easier to review it the more information is provided. The linked library homepage should ideally have the following information:

  • The implemented YAML version(s) (1.0, 1.1, 1.2)
  • How complete the YAML version is implemented; what it doesn't do
  • Which schemas are implemented. See this list of schemas. For YAML 1.2 this should at least be the Core Schema. If it doesn't do resolving (booleans, integers etc.) at all, this information should ideally also be on the homepage.
  • Tests/CI: Does the lib use the official yaml-test-suite? Or does it have its own test cases? Are they linked from the Homepage?

The list of YAML libraries is growing, and they are all very different, so it's important that people can find essential information about the library at one glance.

If you are the author or know the library well, please consider adding it to the docker yaml-runtimes, which is the base for the yaml-test-matrix. This helps making visible how complete the library is.

About, Contact

This git repo is hosted at: https://github.com/yaml/www.yaml.org.

Please file issues and pull requests here: https://github.com/yaml/www.yaml.org/issues.

If you want to chat about YAML or this site, drop by https://matrix.to/#/#chat:yaml.io. If IRC is more your style, join #yaml on the irc.libera.chat network.

Viewing the site locally

You can simply open the local index.html page in your browser.