[ ] Link to some relevant page if applicable (e.g. api3 docs, web page, ...)
[ ] Add standard configuration files (e.g. prettier) as per standard requirements and other repositories.
[ ] Enhance the README.md with high level information about the project and its scope. Update README.md as needed so that it looks well presented on www.npmjs.com, and provides a clear and comprehensive description about the package, including installation instructions, usage examples, and any other relevant information. Package update changesets should not be included in the README.md
[ ] Add the relevant license file LICENSE consistent with the organizational standards or project requirements.
[ ] If applicable, implement unit tests and add a testing framework (e.g., Jest)
[ ] Customize Continuous Integration (CI) workflows to run package-specific tests, linting, and other checks on each commit. Ensure these workflows are optimized for the npm package development cycle.
[ ] Configure Continuous Deployment (CD) for automated publishing to npm, tailored to the package's release and versioning strategy. This step can include setting up semantic versioning automation and npm publish commands.
[ ] Add relevant package.json fields as applicable (e.g. such that repo links and - in this specific case - keywords show up in NPM, compare this to this)
[ ] Create renovate.json configuration file in the root of the repository to manage dependencies effectively, as per our dependency management strategy.
[ ] Set up Renovate for automated security vulnerability scanning to detect vulnerabilities in the codebase.
[ ] Define and document the release process and instructions, and the versioning strategy.
Support GitHub Release (e.g. https://github.com/api3dao/chains/releases) as per our standard guidelines (tag releases, changesets such as these, changelogs, and release notes) and integrate CI/CD to support releases through GitHub as applicable.
As part of the TM issue https://github.com/api3dao/tasks/issues/849 for QA, some requirements need to be addressed:
Repo setup requirements as per new_repo_creation_checklist.md:
README.mdwith high level information about the project and its scope. UpdateREADME.mdas needed so that it looks well presented on www.npmjs.com, and provides a clear and comprehensive description about the package, including installation instructions, usage examples, and any other relevant information. Package update changesets should not be included in theREADME.mdLICENSEconsistent with the organizational standards or project requirements.