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.

Sign up for GitHub

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

Jump to bottom

[Code Health] Move poktroll/internal/ test packages into poktroll/testutil #133

Closed
5 tasks
bryanchriswhite opened this issue Nov 3, 2023 · 0 comments · Fixed by #153
Closed
5 tasks

[Code Health] Move poktroll/internal/ test packages into poktroll/testutil #133

bryanchriswhite opened this issue Nov 3, 2023 · 0 comments · Fixed by #153
Assignees
@bryanchriswhite
Labels
code health Cleans up some code documentation Improvements or additions to documentation testing Test (or test utils) additions, fixes, improvements or other
Milestone
Quality of Life

Comments

@bryanchriswhite
Copy link
Contributor

Objective

Consolidates test helpers for improved discoverability and compatibility with godoc.

Origin Document

Godoc doesn't seem to process internal packages.

Goals

  • Improve discoverability by consolidating repo test helpers
  • Improve developer experience by including all test helpers in godoc pages

Deliverables

  • Move (and update references to) poktroll/internal/... packages to poktroll/testutil/pkg/...

Non-goals / Non-deliverables

  • Refactoring any test helper code
  • Modifying godoc tooling

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @bryanchriswhite
Co-Owners:
@bryanchriswhite bryanchriswhite added documentation Improvements or additions to documentation code health Cleans up some code labels Nov 3, 2023
@bryanchriswhite bryanchriswhite self-assigned this Nov 3, 2023
@bryanchriswhite bryanchriswhite moved this to Draft in Shannon Nov 3, 2023
@bryanchriswhite bryanchriswhite added the testing Test (or test utils) additions, fixes, improvements or other label Nov 7, 2023
@bryanchriswhite bryanchriswhite moved this from Draft to 🏗 In progress in Shannon Nov 7, 2023
@bryanchriswhite bryanchriswhite mentioned this issue Nov 7, 2023
Merged
10 tasks
@bryanchriswhite bryanchriswhite linked a pull request Nov 7, 2023 that will close this issue
[Testing, Docs] refactor: move /internal/... to /testutil/... for godocs #153
Merged
10 tasks
@bryanchriswhite bryanchriswhite moved this from 🏗 In progress to 👀 In review in Shannon Nov 7, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Shannon Nov 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bryanchriswhite bryanchriswhite

Labels
code health Cleans up some code documentation Improvements or additions to documentation testing Test (or test utils) additions, fixes, improvements or other
Projects
Shannon
Status: ✅ Done
Milestone
Quality of Life
Development

Successfully merging a pull request may close this issue.

[Testing, Docs] refactor: move /internal/... to /testutil/... for godocs pokt-network/poktroll
1 participant
@bryanchriswhite