opensearch-project/demos

[FEATURE][DocBot] Move variables into function declarations cluster_bootstrap.py

Open

#65 opened on Oct 23, 2023

View on GitHubContributor guide
 (2 comments) (0 reactions) (1 assignee) (18 forks)auto 404
OSCIenhancementhelp wanted

Repository metrics

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

Description

Is your feature request related to a problem?

When we have parameters hidden in our files we cannot as easily test our changes. To make this code more testable we need to pull things like index names into the function parameters and we can set them as defaults if that makes sense.

https://github.com/opensearch-project/demos/pull/60/files#r1368887197

Contributor guide

Research direction
Identify variables in cluster bootstrap.py that are currently hardcoded or defined outside functions, and move them into function parameters with default values for testability.
Tech stack
python
Domain
backend
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75