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 #1972

Open
8 of 25 tasks
BTT21000 opened this issue Mar 14, 2024 · 1 comment
Open
8 of 25 tasks

Finalize repo QA compliance #1972

BTT21000 opened this issue Mar 14, 2024 · 1 comment

Comments

@BTT21000
Copy link

BTT21000 commented Mar 14, 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]

  • Verify Renovate setup for automated security vulnerability scanning to detect vulnerabilities in the codebase and dependencies.

Package setup requirements as per new_package_creation_checklist.md:

@api3/airnode-abi

  • Edit the README.md if 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 relevant package.json fields if applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/airnode-adapter

  • Add if needed prettier and the .prettierrc configuration file
  • Edit the README.md if 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 relevant package.json fields if applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/airnode-admin

  • Add and edit if needed the key configuration files such as .eslintrc, .prettierrc.
  • Edit the README.md if 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 relevant package.json fields if applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/airnode-deployer

  • Add and edit if needed the key configuration files such as .eslintrc, .prettierrc.
  • Edit the README.md if 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 relevant package.json fields if applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/airnode-examples

  • Add and edit if needed the key configuration files such as .eslintrc, .prettierrc.
  • Add relevant package.json fields if applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/airnode-node

  • Edit the README.md if 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 relevant package.json fields if applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/airnode-operation

  • Add and edit if needed the key configuration files such as .prettierrc.
  • Add relevant package.json fields if applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/airnode-protocol

  • Add and edit if needed the key configuration files such as .prettierrc.
  • Add relevant package.json fields if applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/airnode-utilities

  • Edit the README.md if 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 relevant package.json fields if applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/airnode-validator

  • Add and edit if needed the key configuration files such as .prettierrc.
  • Edit the README.md if 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 relevant package.json fields if applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)
@Siegrift
Copy link
Contributor

@dcroote This is not urgent, so I've un-assigned you from 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

No branches or pull requests

3 participants