Purpose

Model of Package

This serves as the flagship and standard of how a package component should be developed, tested, built, published, documentated and shared. It is the mother and ultimate source of truth of how different tools and services are configured to model the process and standard of shipping a package.

Lord of Tooling

Any idea and optimisation should go into this repo, getting tested and reviewed, and populated to all packages through ncm. It also serves as a single source of place to test any new development tool using its pipeline, and any niche programming edge case that may break the build configuration should be included in the src code here to be tested with any future tooling update. There should be no business logics here, and anything else that can be estabilished as a standard should be prooved here.

Current Standard

• Initialisation: @opbi/ncm
• Development: yarn, babel, eslint, prettier, flow-typed, jsdoc, jest
• Commit: husky, commitlint
• Build & Publish: semantic-release, CircleCI, Coveralls, Scrutiniser, Snyk, Fossa, David, InchCI, Renovate
• Guide & Docs: documentation.js, gitbook, gh-pages, .md
• Deprecation: (@opbi/ncm)

How to Use

License

MIT