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

Open
15 tasks
BTT21000 opened this issue Mar 18, 2024 · 0 comments
Open
15 tasks

Finalize repo QA compliance #317

BTT21000 opened this issue Mar 18, 2024 · 0 comments
Assignees

Comments

@BTT21000
Copy link

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 link to some relevant page if applicable (e.g. docs, web page...)
  • Enhance README.md if needed with key information that provides a clear and comprehensive description about the repo's scope, usage, and any other relevant information.
  • Install Renovate in the repository, following the guidelines outlined in dependencyManagementStrategy.md.
  • Create/review 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 packages release process and instructions, and the versioning strategy.
  • If applicable, configure Continuous Deployment (CD) for automated publishing to npm, tailored to the packages' releases and versioning strategy. This step can include setting up semantic versioning automation and npm publish commands.
  • Customize Continuous Integration (CI) workflows to run packages-specific tests, linting, and other checks on each commit. Ensure these workflows are optimized for the (npm) package development cycle.
  • 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.

Package setup requirements as per new_package_creation_checklist.md:

@api3/api3-voting

  • If applicable (the package does not seem to be accessible on npm?), add relevant package.json fields as applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)
  • Add README.md if needed so that it 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.

@api3/convenience

  • If applicable (the package does not seem to be accessible on npm?), add relevant package.json fields as applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/dao

  • Edit README.md (e.g. update outdated data such as Rinkeby network) so that it 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.
  • If applicable (the package does not seem to be accessible on npm?), add relevant package.json fields as applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)

@api3/pool

  • If applicable (the package does not seem to be accessible on npm?), add relevant package.json fields as applicable (e.g. such that repo links, description, keywords, and author show up in NPM, compare this to this)
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

2 participants