Skip to content

Latest commit

 

History

History
166 lines (117 loc) · 5.32 KB

CONTRIBUTING.md

File metadata and controls

166 lines (117 loc) · 5.32 KB
Raw

Contributing

Code of Conduct

Respect the Code of Conduct

Coding Style Guides

Read existing code to analyze the coding style.

Licensing

Any contribution that is incorporated into the project has by default the license of the project. Until then, all contributions including issues are "CC0-1.0".

Attribution, Identities and links

Any major contributor may ask (it is opt in) to have the name/username and 1 link and 1 private contact and 1 enterprise/donation link of the major contributor included in both readme and official documentation.

A major contributor is someone who made at least 1 significant contribution.

About this guide

Use this guide as guidance not as strict rules.

How

Questions

Feel free to ask any question.

Reporting Bugs

Thanks. Give as many relevant details as possible.

Suggestions

Thanks.

Queries

Feel free to query any kind of upgrades. Contributors are allowed to ask for payment.

Pull Request or Make any Changes

npm run to list all commands.

http-server or python -m http.server 8080 to serve static files. (use a second command prompt to be able to rebuild while serving)

  • Discuss with in the chat, and/or open issue first to discuss
  • Fork, create branch, make changes, Pull request (recommended)
  • OR clone + make changes + send changed files via message

Donations

Open an issue to make us open a donation channel

What to do

  • explain the philosophy that dom99 is really low level API and is made to be encapsulated inside a framework that give better developer experience. Show how to do it inside create-dom99-app

  • explain better where dom99 comes from and what differentiates it

  • compare values before updating ? with data-compare-before ?

  • Create a better documentation experience

    • New html page with articles
      • Security
      • Performance
      • DOM the good parts
    • Redefine sections

      • About

        • Move to Details everything except the essential
        • Add 2 inlines examples, (move all other inline examples to another html page)
          • Proper syntax highlighting

      • Step by step

        • Install
        • Setup
        • Hello World

      • Advanced concepts

      • make a link to API

      • Components

      • Plugins

      • Details (license, chat, contribute etc)

      • Changelog (recent)

        • Move full timeline elsewhere

  • Define typical process of creating and composing with custom elements

  • IE seems to fill forms after script executes and load (onload ?)

  • http://localhost:8080/examples/limited.html cannot set -4 in global (needs info)

  • see how checking for equality before assigning textContent affects performance

  • further explore and document best practices for

    • keyboard shortcuts, (acceskey, keydown listener), gamepad support
    • form validation, form submits
      • web payements
      • speech to text
      • biometric authentification (facial, voice, fingerprint recognition),
      • 2 factors (ex password + token)
      • social authentification (Open Auth ?)
    • multimedia content,
      • audio , text to speech
      • video
      • canvas
      • VR, AR
    • local navigation (menu bars, links, buttons)
    • disabled js, and fall-backs
    • cross device support, phone, tablets, fridges, smartwatch, tv
      • UX, css media queries, button size, pointer events, touch events, both
    • website monetization and growth
      • navigator.share
      • social network sharing, email link
      • donation links

  • server side rendering

    • static
    • on the fly, streaming html

  • better developer tools

    • indexed error messages in the doc
    • more warnings
    • text editors plugins

  • lit-html compatible API could be interesting

  • add tabindex="0" when data-function="keydown-anyname" is used on something that does not have focus by default (like div), and no tabindex is already set, body does not need it

  • https://github.com/bfred-it/select-dom see if that is faster to iterate on every dom element that has data-*

  • hash values for smaller memory footprint comparison (trade would make it slower make it an option)

  • don't use blah blah in examples it is distracting, make more standard examples like todoMVC

  • finish https://github.com/GrosSacASac/DOM99/community

  • add examples for async (network) data and how it looks

  • re-generate landing-page.min.css from source landing-page.css

  • top level variable integration like displayjs experiment

  • base dom99 lighter

  • revisit the context API

  • harmonize the vocabulary for context path etc

  • jsdoc show better optional parameters

  • solve race conditions in templates4.html

  • has no context. contextFromEvent for top level elements is not needed. could warn when empty string or undefined is returned document ELEMENT_PROPERTY, LIST_ITEM_PROPERTY, CONTEXT element extension, use WeakMap instead where supported

    decide when to use event .target .orignialTarget .currentTarget

    add data-list-strategy to allow opt in declarative optimization same length, different content same content, different length key based identification data-function-context to allow context less

    transform recursive into sequential flow

    add data-scoped for data-function to allow them to be scoped inside an element with data-inside ?

    explore addEventListener(x, y, {passive: true});