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

[Testing] Establish a pattern for how to use TestMain #709

Open
6 tasks
Olshansk opened this issue Apr 28, 2023 · 0 comments
Open
6 tasks

[Testing] Establish a pattern for how to use TestMain #709

Olshansk opened this issue Apr 28, 2023 · 0 comments
Assignees
Labels
code health Nice to have code improvement core starter task Good for newcomers, but aimed at core team members though still open for everyone documentation Improvements or additions to documentation testing Defining, adding, automating or modifying tests

Comments

@Olshansk
Copy link
Member

Objective

Establishing a convention for how to use, name and define TestMain in each individual module

Origin Document

#683 (comment)

Screenshot 2023-04-28 at 1 34 57 PM

Goals

  • Creating a standard for file and function naming for test helpers to have consistency and reduce cognitive load
  • Make it easier for new developers to follow module specific patterns

Deliverable

  • Establishing and documenting a convention for naming test files containing TestMain and helpers in each module
  • Updating and renaming all files containing a TestMain function

Non-goals / Non-deliverables

  • Modifying the logic existing tests
  • Consolidating test helpers across modules (optional)

General issue deliverables

  • Update the appropriate CHANGELOG(s)
  • Update any relevant local/global README(s)
  • Update relevant source code tree explanations

Testing Methodology

  • All tests: make test_all

Creator: @Olshansk
Co-Owners: @bryanchriswhite

@Olshansk Olshansk added documentation Improvements or additions to documentation code health Nice to have code improvement core starter task Good for newcomers, but aimed at core team members though still open for everyone testing Defining, adding, automating or modifying tests labels Apr 28, 2023
@Olshansk Olshansk changed the title [REPLACE ME] with a descriptive title [Testing] Establish a pattern for how to use TestMain May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health Nice to have code improvement core starter task Good for newcomers, but aimed at core team members though still open for everyone documentation Improvements or additions to documentation testing Defining, adding, automating or modifying tests
Projects
Status: Backlog
Development

No branches or pull requests

2 participants