opensearch-project/demos

[FEATURE][DocBot] Automated testing of DocBot

Open

#95 opened on Nov 7, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees) (18 forks)auto 404
OSCIenhancementgood first issue

Repository metrics

Stars
 (4 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem?

At the moment we have some tests and we have a framework for running things automatically on commit. These two should work together.

What solution would you like?

There should be a workflow in our pre-commit-config.yaml that will automatically run tests before allowing commits. This way we can ensure that we have a working code base with each commit.

Here is an example of what this may look like: https://stackoverflow.com/a/64014324. Additional note we may need to do some work to get our tests into better shape.

Contributor guide

Research direction
Review the existing tests and pre commit configuration. Understand the testing framework (likely pytest). Add a hook in .pre commit config.yaml to run tests before commits, following the StackOverflow example provided. Ensure tests pass or fix them if needed.
Tech stack
None
Domain
devopstesting
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75