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

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

Finalize repo QA compliance #32

BTT21000 opened this issue Mar 18, 2024 · 0 comments
Assignees
Labels
Nodary To be present on the project Nodary API board

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:

  • 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)
  • Install Renovate in the repository, following the guidelines outlined in dependencyManagementStrategy.md.
  • 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.
@PrenaamD PrenaamD added the Nodary To be present on the project Nodary API board label Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Nodary To be present on the project Nodary API board
Projects
None yet
Development

No branches or pull requests

3 participants