Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 1.82 KB

DEVELOPERS.md

File metadata and controls

29 lines (23 loc) · 1.82 KB
Raw

Developers

This repository uses git hooks to ensure some code quality standards and provide test automation.

Roadmap and issue tracking

My personal roadmap is in roadmap.md. You may pick any unfinished issue you would like to work on, from any version number.

changelog.md is automatically maintained:

  • The 'Latest' commits are filled in by git hooks.
  • Version bumps can be performed by running npm run verbump -- major/minor/patch MESSAGE, but this should only be done by the repository owner, to prevent tags going everywhere.

roadmap.md is manually maintained. Feel free to clear out sections that have been implemented.

Code style

Upon npm run, this repository will install some githooks which automatically lint your code before you commit. These will be checked by CICD in future. The tests are:

  • eslint
  • jest testing
  • At least 10 letters and first letter capital commit messages.

Release process

  • npm run verbump major/minor/patch message
  • npm run deploy-to-gh-pages
  • git push --force origin gh-pages:gh-pages

Code style rules

To be enforced by linter, some day in the future. I know i am using terms like 'importance' which are heuristic and may not be determinable by a machine, but we can try our best

  • default export functions should come first in the file, only to be preceded by higher importance types
    • default export can be exported as the last thing in the file, if it is a named default export
  • a default export must have the same name as its file. if it has a different name, make it not a default export
  • DOMASSERTION: DOM does not have assertions; but assertions are useful. Making DomAssert a function causes the throw statement to always appear in the DomAssert function, which is not helpful. Hence we use a non-idiomatic non braced if statement with the DOMASSERTION comment to mark assertions.