Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Finalize repo QA compliance #269

Closed
8 tasks done
BTT21000 opened this issue Mar 15, 2024 · 0 comments · Fixed by #272
Closed
8 tasks done

Finalize repo QA compliance #269

BTT21000 opened this issue Mar 15, 2024 · 0 comments · Fixed by #272
Assignees

Comments

@BTT21000
Copy link

BTT21000 commented Mar 15, 2024

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:

  • Add standard configuration files (in this case eslint, ...) as per standard requirements and other repositories.
  • Add the relevant license file (LICENSE.md) consistent with the organizational standards or project requirements.

Package setup requirements as per new_package_creation_checklist.md:

  • Edit the 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.
  • Implement unit tests and add a testing framework (e.g., Jest, Mocha) if applicable.
  • 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.
  • 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)
  • Review the renovate.json configuration file to ensure it satisfies the package requirements and align with our dependency management strategy.
  • Verify the setup of security vulnerability scanning tools (e.g. Renovate) for the codebase and dependencies.
@hiletmis hiletmis self-assigned this Mar 20, 2024
@hiletmis hiletmis linked a pull request Mar 20, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants